Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-recoveryservices-siterecovery

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

A2ARpRecoveryPointType

A2ARpRecoveryPointType: "Latest" | "LatestApplicationConsistent" | "LatestCrashConsistent" | "LatestProcessed"

Defines values for A2ARpRecoveryPointType. Possible values include: 'Latest', 'LatestApplicationConsistent', 'LatestCrashConsistent', 'LatestProcessed'

readonly
enum

{string}

AgentAutoUpdateStatus

AgentAutoUpdateStatus: "Disabled" | "Enabled"

Defines values for AgentAutoUpdateStatus. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

AgentVersionStatus

AgentVersionStatus: "Supported" | "NotSupported" | "Deprecated" | "UpdateRequired" | "SecurityUpdateRequired"

Defines values for AgentVersionStatus. Possible values include: 'Supported', 'NotSupported', 'Deprecated', 'UpdateRequired', 'SecurityUpdateRequired'

readonly
enum

{string}

AlternateLocationRecoveryOption

AlternateLocationRecoveryOption: "CreateVmIfNotFound" | "NoAction"

Defines values for AlternateLocationRecoveryOption. Possible values include: 'CreateVmIfNotFound', 'NoAction'

readonly
enum

{string}

ApplyRecoveryPointProviderSpecificInputUnion

Contains the possible cases for ApplyRecoveryPointProviderSpecificInput.

ConfigurationSettingsUnion

Contains the possible cases for ConfigurationSettings.

DataSyncStatus

DataSyncStatus: "ForDownTime" | "ForSynchronization"

Defines values for DataSyncStatus. Possible values include: 'ForDownTime', 'ForSynchronization'

readonly
enum

{string}

DisableProtectionProviderSpecificInputUnion

Contains the possible cases for DisableProtectionProviderSpecificInput.

DisableProtectionReason

DisableProtectionReason: "NotSpecified" | "MigrationComplete"

Defines values for DisableProtectionReason. Possible values include: 'NotSpecified', 'MigrationComplete'

readonly
enum

{string}

EnableProtectionProviderSpecificInputUnion

Contains the possible cases for EnableProtectionProviderSpecificInput.

EventProviderSpecificDetailsUnion

Contains the possible cases for EventProviderSpecificDetails.

EventSpecificDetailsUnion

EventSpecificDetailsUnion: EventSpecificDetails | JobStatusEventDetails

Contains the possible cases for EventSpecificDetails.

FabricSpecificCreateNetworkMappingInputUnion

Contains the possible cases for FabricSpecificCreateNetworkMappingInput.

FabricSpecificCreationInputUnion

Contains the possible cases for FabricSpecificCreationInput.

FabricSpecificDetailsUnion

Contains the possible cases for FabricSpecificDetails.

FabricSpecificUpdateNetworkMappingInputUnion

Contains the possible cases for FabricSpecificUpdateNetworkMappingInput.

FailoverDeploymentModel

FailoverDeploymentModel: "NotApplicable" | "Classic" | "ResourceManager"

Defines values for FailoverDeploymentModel. Possible values include: 'NotApplicable', 'Classic', 'ResourceManager'

readonly
enum

{string}

GroupTaskDetailsUnion

Contains the possible cases for GroupTaskDetails.

HealthErrorCategory

HealthErrorCategory: "None" | "Replication" | "TestFailover" | "Configuration" | "FabricInfrastructure" | "VersionExpiry" | "AgentAutoUpdate"

Defines values for HealthErrorCategory. Possible values include: 'None', 'Replication', 'TestFailover', 'Configuration', 'FabricInfrastructure', 'VersionExpiry', 'AgentAutoUpdate'

readonly
enum

{string}

HyperVReplicaAzureRpRecoveryPointType

HyperVReplicaAzureRpRecoveryPointType: "Latest" | "LatestApplicationConsistent" | "LatestProcessed"

Defines values for HyperVReplicaAzureRpRecoveryPointType. Possible values include: 'Latest', 'LatestApplicationConsistent', 'LatestProcessed'

readonly
enum

{string}

IdentityProviderType

IdentityProviderType: "RecoveryServicesActiveDirectory"

Defines values for IdentityProviderType. Possible values include: 'RecoveryServicesActiveDirectory'

readonly
enum

{string}

InMageV2RpRecoveryPointType

InMageV2RpRecoveryPointType: "Latest" | "LatestApplicationConsistent" | "LatestCrashConsistent" | "LatestProcessed"

Defines values for InMageV2RpRecoveryPointType. Possible values include: 'Latest', 'LatestApplicationConsistent', 'LatestCrashConsistent', 'LatestProcessed'

readonly
enum

{string}

JobDetailsUnion

Contains the possible cases for JobDetails.

LicenseType

LicenseType: "NotSpecified" | "NoLicenseType" | "WindowsServer"

Defines values for LicenseType. Possible values include: 'NotSpecified', 'NoLicenseType', 'WindowsServer'

readonly
enum

{string}

MultiVmGroupCreateOption

MultiVmGroupCreateOption: "AutoCreated" | "UserSpecified"

Defines values for MultiVmGroupCreateOption. Possible values include: 'AutoCreated', 'UserSpecified'

readonly
enum

{string}

MultiVmSyncPointOption

MultiVmSyncPointOption: "UseMultiVmSyncRecoveryPoint" | "UsePerVmRecoveryPoint"

Defines values for MultiVmSyncPointOption. Possible values include: 'UseMultiVmSyncRecoveryPoint', 'UsePerVmRecoveryPoint'

readonly
enum

{string}

MultiVmSyncStatus

MultiVmSyncStatus: "Enabled" | "Disabled"

Defines values for MultiVmSyncStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

NetworkMappingFabricSpecificSettingsUnion

Contains the possible cases for NetworkMappingFabricSpecificSettings.

OperationsListNextResponse

OperationsListNextResponse: OperationsDiscoveryCollection & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationsDiscoveryCollection & object

Contains response data for the list operation.

PolicyProviderSpecificDetailsUnion

Contains the possible cases for PolicyProviderSpecificDetails.

PolicyProviderSpecificInputUnion

Contains the possible cases for PolicyProviderSpecificInput.

PossibleOperationsDirections

PossibleOperationsDirections: "PrimaryToRecovery" | "RecoveryToPrimary"

Defines values for PossibleOperationsDirections. Possible values include: 'PrimaryToRecovery', 'RecoveryToPrimary'

readonly
enum

{string}

PresenceStatus

PresenceStatus: "Unknown" | "Present" | "NotPresent"

Defines values for PresenceStatus. Possible values include: 'Unknown', 'Present', 'NotPresent'

readonly
enum

{string}

ProtectionContainerMappingProviderSpecificDetailsUnion

ProtectionContainerMappingProviderSpecificDetailsUnion: ProtectionContainerMappingProviderSpecificDetails | A2AProtectionContainerMappingDetails

Contains the possible cases for ProtectionContainerMappingProviderSpecificDetails.

ProviderSpecificFailoverInputUnion

Contains the possible cases for ProviderSpecificFailoverInput.

ProviderSpecificRecoveryPointDetailsUnion

Contains the possible cases for ProviderSpecificRecoveryPointDetails.

RecoveryPlanActionDetailsUnion

Contains the possible cases for RecoveryPlanActionDetails.

RecoveryPlanActionLocation

RecoveryPlanActionLocation: "Primary" | "Recovery"

Defines values for RecoveryPlanActionLocation. Possible values include: 'Primary', 'Recovery'

readonly
enum

{string}

RecoveryPlanGroupType

RecoveryPlanGroupType: "Shutdown" | "Boot" | "Failover"

Defines values for RecoveryPlanGroupType. Possible values include: 'Shutdown', 'Boot', 'Failover'

readonly
enum

{string}

RecoveryPlanProviderSpecificFailoverInputUnion

Contains the possible cases for RecoveryPlanProviderSpecificFailoverInput.

RecoveryPointSyncType

RecoveryPointSyncType: "MultiVmSyncRecoveryPoint" | "PerVmRecoveryPoint"

Defines values for RecoveryPointSyncType. Possible values include: 'MultiVmSyncRecoveryPoint', 'PerVmRecoveryPoint'

readonly
enum

{string}

RecoveryPointType

RecoveryPointType: "LatestTime" | "LatestTag" | "Custom"

Defines values for RecoveryPointType. Possible values include: 'LatestTime', 'LatestTag', 'Custom'

readonly
enum

{string}

RecoveryPointsGetResponse

RecoveryPointsGetResponse: RecoveryPoint & object

Contains response data for the get operation.

RecoveryPointsListByReplicationProtectedItemsNextResponse

RecoveryPointsListByReplicationProtectedItemsNextResponse: RecoveryPointCollection & object

Contains response data for the listByReplicationProtectedItemsNext operation.

RecoveryPointsListByReplicationProtectedItemsResponse

RecoveryPointsListByReplicationProtectedItemsResponse: RecoveryPointCollection & object

Contains response data for the listByReplicationProtectedItems operation.

ReplicationAlertSettingsCreateResponse

ReplicationAlertSettingsCreateResponse: Alert & object

Contains response data for the create operation.

ReplicationAlertSettingsGetResponse

ReplicationAlertSettingsGetResponse: Alert & object

Contains response data for the get operation.

ReplicationAlertSettingsListNextResponse

ReplicationAlertSettingsListNextResponse: AlertCollection & object

Contains response data for the listNext operation.

ReplicationAlertSettingsListResponse

ReplicationAlertSettingsListResponse: AlertCollection & object

Contains response data for the list operation.

ReplicationEventsGetResponse

ReplicationEventsGetResponse: Event & object

Contains response data for the get operation.

ReplicationEventsListNextResponse

ReplicationEventsListNextResponse: EventCollection & object

Contains response data for the listNext operation.

ReplicationEventsListResponse

ReplicationEventsListResponse: EventCollection & object

Contains response data for the list operation.

ReplicationFabricsBeginCheckConsistencyResponse

ReplicationFabricsBeginCheckConsistencyResponse: Fabric & object

Contains response data for the beginCheckConsistency operation.

ReplicationFabricsBeginCreateResponse

ReplicationFabricsBeginCreateResponse: Fabric & object

Contains response data for the beginCreate operation.

ReplicationFabricsBeginReassociateGatewayResponse

ReplicationFabricsBeginReassociateGatewayResponse: Fabric & object

Contains response data for the beginReassociateGateway operation.

ReplicationFabricsBeginRenewCertificateResponse

ReplicationFabricsBeginRenewCertificateResponse: Fabric & object

Contains response data for the beginRenewCertificate operation.

ReplicationFabricsCheckConsistencyResponse

ReplicationFabricsCheckConsistencyResponse: Fabric & object

Contains response data for the checkConsistency operation.

ReplicationFabricsCreateResponse

ReplicationFabricsCreateResponse: Fabric & object

Contains response data for the create operation.

ReplicationFabricsGetResponse

ReplicationFabricsGetResponse: Fabric & object

Contains response data for the get operation.

ReplicationFabricsListNextResponse

ReplicationFabricsListNextResponse: FabricCollection & object

Contains response data for the listNext operation.

ReplicationFabricsListResponse

ReplicationFabricsListResponse: FabricCollection & object

Contains response data for the list operation.

ReplicationFabricsReassociateGatewayResponse

ReplicationFabricsReassociateGatewayResponse: Fabric & object

Contains response data for the reassociateGateway operation.

ReplicationFabricsRenewCertificateResponse

ReplicationFabricsRenewCertificateResponse: Fabric & object

Contains response data for the renewCertificate operation.

ReplicationJobsBeginCancelResponse

ReplicationJobsBeginCancelResponse: Job & object

Contains response data for the beginCancel operation.

ReplicationJobsBeginExportMethodResponse

ReplicationJobsBeginExportMethodResponse: Job & object

Contains response data for the beginExportMethod operation.

ReplicationJobsBeginRestartResponse

ReplicationJobsBeginRestartResponse: Job & object

Contains response data for the beginRestart operation.

ReplicationJobsBeginResumeResponse

ReplicationJobsBeginResumeResponse: Job & object

Contains response data for the beginResume operation.

ReplicationJobsCancelResponse

ReplicationJobsCancelResponse: Job & object

Contains response data for the cancel operation.

ReplicationJobsExportMethodResponse

ReplicationJobsExportMethodResponse: Job & object

Contains response data for the exportMethod operation.

ReplicationJobsGetResponse

ReplicationJobsGetResponse: Job & object

Contains response data for the get operation.

ReplicationJobsListNextResponse

ReplicationJobsListNextResponse: JobCollection & object

Contains response data for the listNext operation.

ReplicationJobsListResponse

ReplicationJobsListResponse: JobCollection & object

Contains response data for the list operation.

ReplicationJobsRestartResponse

ReplicationJobsRestartResponse: Job & object

Contains response data for the restart operation.

ReplicationJobsResumeResponse

ReplicationJobsResumeResponse: Job & object

Contains response data for the resume operation.

ReplicationLogicalNetworksGetResponse

ReplicationLogicalNetworksGetResponse: LogicalNetwork & object

Contains response data for the get operation.

ReplicationLogicalNetworksListByReplicationFabricsNextResponse

ReplicationLogicalNetworksListByReplicationFabricsNextResponse: LogicalNetworkCollection & object

Contains response data for the listByReplicationFabricsNext operation.

ReplicationLogicalNetworksListByReplicationFabricsResponse

ReplicationLogicalNetworksListByReplicationFabricsResponse: LogicalNetworkCollection & object

Contains response data for the listByReplicationFabrics operation.

ReplicationNetworkMappingsBeginCreateResponse

ReplicationNetworkMappingsBeginCreateResponse: NetworkMapping & object

Contains response data for the beginCreate operation.

ReplicationNetworkMappingsBeginUpdateResponse

ReplicationNetworkMappingsBeginUpdateResponse: NetworkMapping & object

Contains response data for the beginUpdate operation.

ReplicationNetworkMappingsCreateResponse

ReplicationNetworkMappingsCreateResponse: NetworkMapping & object

Contains response data for the create operation.

ReplicationNetworkMappingsGetResponse

ReplicationNetworkMappingsGetResponse: NetworkMapping & object

Contains response data for the get operation.

ReplicationNetworkMappingsListByReplicationNetworksNextResponse

ReplicationNetworkMappingsListByReplicationNetworksNextResponse: NetworkMappingCollection & object

Contains response data for the listByReplicationNetworksNext operation.

ReplicationNetworkMappingsListByReplicationNetworksResponse

ReplicationNetworkMappingsListByReplicationNetworksResponse: NetworkMappingCollection & object

Contains response data for the listByReplicationNetworks operation.

ReplicationNetworkMappingsListNextResponse

ReplicationNetworkMappingsListNextResponse: NetworkMappingCollection & object

Contains response data for the listNext operation.

ReplicationNetworkMappingsListResponse

ReplicationNetworkMappingsListResponse: NetworkMappingCollection & object

Contains response data for the list operation.

ReplicationNetworkMappingsUpdateResponse

ReplicationNetworkMappingsUpdateResponse: NetworkMapping & object

Contains response data for the update operation.

ReplicationNetworksGetResponse

ReplicationNetworksGetResponse: Network & object

Contains response data for the get operation.

ReplicationNetworksListByReplicationFabricsNextResponse

ReplicationNetworksListByReplicationFabricsNextResponse: NetworkCollection & object

Contains response data for the listByReplicationFabricsNext operation.

ReplicationNetworksListByReplicationFabricsResponse

ReplicationNetworksListByReplicationFabricsResponse: NetworkCollection & object

Contains response data for the listByReplicationFabrics operation.

ReplicationNetworksListNextResponse

ReplicationNetworksListNextResponse: NetworkCollection & object

Contains response data for the listNext operation.

ReplicationNetworksListResponse

ReplicationNetworksListResponse: NetworkCollection & object

Contains response data for the list operation.

ReplicationPoliciesBeginCreateResponse

ReplicationPoliciesBeginCreateResponse: Policy & object

Contains response data for the beginCreate operation.

ReplicationPoliciesBeginUpdateResponse

ReplicationPoliciesBeginUpdateResponse: Policy & object

Contains response data for the beginUpdate operation.

ReplicationPoliciesCreateResponse

ReplicationPoliciesCreateResponse: Policy & object

Contains response data for the create operation.

ReplicationPoliciesGetResponse

ReplicationPoliciesGetResponse: Policy & object

Contains response data for the get operation.

ReplicationPoliciesListNextResponse

ReplicationPoliciesListNextResponse: PolicyCollection & object

Contains response data for the listNext operation.

ReplicationPoliciesListResponse

ReplicationPoliciesListResponse: PolicyCollection & object

Contains response data for the list operation.

ReplicationPoliciesUpdateResponse

ReplicationPoliciesUpdateResponse: Policy & object

Contains response data for the update operation.

ReplicationProtectableItemsGetResponse

ReplicationProtectableItemsGetResponse: ProtectableItem & object

Contains response data for the get operation.

ReplicationProtectableItemsListByReplicationProtectionContainersNextResponse

ReplicationProtectableItemsListByReplicationProtectionContainersNextResponse: ProtectableItemCollection & object

Contains response data for the listByReplicationProtectionContainersNext operation.

ReplicationProtectableItemsListByReplicationProtectionContainersResponse

ReplicationProtectableItemsListByReplicationProtectionContainersResponse: ProtectableItemCollection & object

Contains response data for the listByReplicationProtectionContainers operation.

ReplicationProtectedItemOperation

ReplicationProtectedItemOperation: "ReverseReplicate" | "Commit" | "PlannedFailover" | "UnplannedFailover" | "DisableProtection" | "TestFailover" | "TestFailoverCleanup" | "Failback" | "FinalizeFailback" | "ChangePit" | "RepairReplication" | "SwitchProtection" | "CompleteMigration"

Defines values for ReplicationProtectedItemOperation. Possible values include: 'ReverseReplicate', 'Commit', 'PlannedFailover', 'UnplannedFailover', 'DisableProtection', 'TestFailover', 'TestFailoverCleanup', 'Failback', 'FinalizeFailback', 'ChangePit', 'RepairReplication', 'SwitchProtection', 'CompleteMigration'

readonly
enum

{string}

ReplicationProtectedItemsApplyRecoveryPointResponse

ReplicationProtectedItemsApplyRecoveryPointResponse: ReplicationProtectedItem & object

Contains response data for the applyRecoveryPoint operation.

ReplicationProtectedItemsBeginApplyRecoveryPointResponse

ReplicationProtectedItemsBeginApplyRecoveryPointResponse: ReplicationProtectedItem & object

Contains response data for the beginApplyRecoveryPoint operation.

ReplicationProtectedItemsBeginCreateResponse

ReplicationProtectedItemsBeginCreateResponse: ReplicationProtectedItem & object

Contains response data for the beginCreate operation.

ReplicationProtectedItemsBeginFailoverCommitResponse

ReplicationProtectedItemsBeginFailoverCommitResponse: ReplicationProtectedItem & object

Contains response data for the beginFailoverCommit operation.

ReplicationProtectedItemsBeginPlannedFailoverResponse

ReplicationProtectedItemsBeginPlannedFailoverResponse: ReplicationProtectedItem & object

Contains response data for the beginPlannedFailover operation.

ReplicationProtectedItemsBeginRepairReplicationResponse

ReplicationProtectedItemsBeginRepairReplicationResponse: ReplicationProtectedItem & object

Contains response data for the beginRepairReplication operation.

ReplicationProtectedItemsBeginReprotectResponse

ReplicationProtectedItemsBeginReprotectResponse: ReplicationProtectedItem & object

Contains response data for the beginReprotect operation.

ReplicationProtectedItemsBeginTestFailoverCleanupResponse

ReplicationProtectedItemsBeginTestFailoverCleanupResponse: ReplicationProtectedItem & object

Contains response data for the beginTestFailoverCleanup operation.

ReplicationProtectedItemsBeginTestFailoverResponse

ReplicationProtectedItemsBeginTestFailoverResponse: ReplicationProtectedItem & object

Contains response data for the beginTestFailover operation.

ReplicationProtectedItemsBeginUnplannedFailoverResponse

ReplicationProtectedItemsBeginUnplannedFailoverResponse: ReplicationProtectedItem & object

Contains response data for the beginUnplannedFailover operation.

ReplicationProtectedItemsBeginUpdateMobilityServiceResponse

ReplicationProtectedItemsBeginUpdateMobilityServiceResponse: ReplicationProtectedItem & object

Contains response data for the beginUpdateMobilityService operation.

ReplicationProtectedItemsBeginUpdateResponse

ReplicationProtectedItemsBeginUpdateResponse: ReplicationProtectedItem & object

Contains response data for the beginUpdate operation.

ReplicationProtectedItemsCreateResponse

ReplicationProtectedItemsCreateResponse: ReplicationProtectedItem & object

Contains response data for the create operation.

ReplicationProtectedItemsFailoverCommitResponse

ReplicationProtectedItemsFailoverCommitResponse: ReplicationProtectedItem & object

Contains response data for the failoverCommit operation.

ReplicationProtectedItemsGetResponse

ReplicationProtectedItemsGetResponse: ReplicationProtectedItem & object

Contains response data for the get operation.

ReplicationProtectedItemsListByReplicationProtectionContainersNextResponse

ReplicationProtectedItemsListByReplicationProtectionContainersNextResponse: ReplicationProtectedItemCollection & object

Contains response data for the listByReplicationProtectionContainersNext operation.

ReplicationProtectedItemsListByReplicationProtectionContainersResponse

ReplicationProtectedItemsListByReplicationProtectionContainersResponse: ReplicationProtectedItemCollection & object

Contains response data for the listByReplicationProtectionContainers operation.

ReplicationProtectedItemsListNextResponse

ReplicationProtectedItemsListNextResponse: ReplicationProtectedItemCollection & object

Contains response data for the listNext operation.

ReplicationProtectedItemsListResponse

ReplicationProtectedItemsListResponse: ReplicationProtectedItemCollection & object

Contains response data for the list operation.

ReplicationProtectedItemsPlannedFailoverResponse

ReplicationProtectedItemsPlannedFailoverResponse: ReplicationProtectedItem & object

Contains response data for the plannedFailover operation.

ReplicationProtectedItemsRepairReplicationResponse

ReplicationProtectedItemsRepairReplicationResponse: ReplicationProtectedItem & object

Contains response data for the repairReplication operation.

ReplicationProtectedItemsReprotectResponse

ReplicationProtectedItemsReprotectResponse: ReplicationProtectedItem & object

Contains response data for the reprotect operation.

ReplicationProtectedItemsTestFailoverCleanupResponse

ReplicationProtectedItemsTestFailoverCleanupResponse: ReplicationProtectedItem & object

Contains response data for the testFailoverCleanup operation.

ReplicationProtectedItemsTestFailoverResponse

ReplicationProtectedItemsTestFailoverResponse: ReplicationProtectedItem & object

Contains response data for the testFailover operation.

ReplicationProtectedItemsUnplannedFailoverResponse

ReplicationProtectedItemsUnplannedFailoverResponse: ReplicationProtectedItem & object

Contains response data for the unplannedFailover operation.

ReplicationProtectedItemsUpdateMobilityServiceResponse

ReplicationProtectedItemsUpdateMobilityServiceResponse: ReplicationProtectedItem & object

Contains response data for the updateMobilityService operation.

ReplicationProtectedItemsUpdateResponse

ReplicationProtectedItemsUpdateResponse: ReplicationProtectedItem & object

Contains response data for the update operation.

ReplicationProtectionContainerMappingsBeginCreateResponse

ReplicationProtectionContainerMappingsBeginCreateResponse: ProtectionContainerMapping & object

Contains response data for the beginCreate operation.

ReplicationProtectionContainerMappingsBeginUpdateResponse

ReplicationProtectionContainerMappingsBeginUpdateResponse: ProtectionContainerMapping & object

Contains response data for the beginUpdate operation.

ReplicationProtectionContainerMappingsCreateResponse

ReplicationProtectionContainerMappingsCreateResponse: ProtectionContainerMapping & object

Contains response data for the create operation.

ReplicationProtectionContainerMappingsGetResponse

ReplicationProtectionContainerMappingsGetResponse: ProtectionContainerMapping & object

Contains response data for the get operation.

ReplicationProtectionContainerMappingsListByReplicationProtectionContainersNextResponse

ReplicationProtectionContainerMappingsListByReplicationProtectionContainersNextResponse: ProtectionContainerMappingCollection & object

Contains response data for the listByReplicationProtectionContainersNext operation.

ReplicationProtectionContainerMappingsListByReplicationProtectionContainersResponse

ReplicationProtectionContainerMappingsListByReplicationProtectionContainersResponse: ProtectionContainerMappingCollection & object

Contains response data for the listByReplicationProtectionContainers operation.

ReplicationProtectionContainerMappingsListNextResponse

ReplicationProtectionContainerMappingsListNextResponse: ProtectionContainerMappingCollection & object

Contains response data for the listNext operation.

ReplicationProtectionContainerMappingsListResponse

ReplicationProtectionContainerMappingsListResponse: ProtectionContainerMappingCollection & object

Contains response data for the list operation.

ReplicationProtectionContainerMappingsUpdateResponse

ReplicationProtectionContainerMappingsUpdateResponse: ProtectionContainerMapping & object

Contains response data for the update operation.

ReplicationProtectionContainersBeginCreateResponse

ReplicationProtectionContainersBeginCreateResponse: ProtectionContainer & object

Contains response data for the beginCreate operation.

ReplicationProtectionContainersBeginDiscoverProtectableItemResponse

ReplicationProtectionContainersBeginDiscoverProtectableItemResponse: ProtectionContainer & object

Contains response data for the beginDiscoverProtectableItem operation.

ReplicationProtectionContainersBeginSwitchProtectionResponse

ReplicationProtectionContainersBeginSwitchProtectionResponse: ProtectionContainer & object

Contains response data for the beginSwitchProtection operation.

ReplicationProtectionContainersCreateResponse

ReplicationProtectionContainersCreateResponse: ProtectionContainer & object

Contains response data for the create operation.

ReplicationProtectionContainersDiscoverProtectableItemResponse

ReplicationProtectionContainersDiscoverProtectableItemResponse: ProtectionContainer & object

Contains response data for the discoverProtectableItem operation.

ReplicationProtectionContainersGetResponse

ReplicationProtectionContainersGetResponse: ProtectionContainer & object

Contains response data for the get operation.

ReplicationProtectionContainersListByReplicationFabricsNextResponse

ReplicationProtectionContainersListByReplicationFabricsNextResponse: ProtectionContainerCollection & object

Contains response data for the listByReplicationFabricsNext operation.

ReplicationProtectionContainersListByReplicationFabricsResponse

ReplicationProtectionContainersListByReplicationFabricsResponse: ProtectionContainerCollection & object

Contains response data for the listByReplicationFabrics operation.

ReplicationProtectionContainersListNextResponse

ReplicationProtectionContainersListNextResponse: ProtectionContainerCollection & object

Contains response data for the listNext operation.

ReplicationProtectionContainersListResponse

ReplicationProtectionContainersListResponse: ProtectionContainerCollection & object

Contains response data for the list operation.

ReplicationProtectionContainersSwitchProtectionResponse

ReplicationProtectionContainersSwitchProtectionResponse: ProtectionContainer & object

Contains response data for the switchProtection operation.

ReplicationProviderSpecificContainerCreationInputUnion

ReplicationProviderSpecificContainerCreationInputUnion: ReplicationProviderSpecificContainerCreationInput | A2AContainerCreationInput

Contains the possible cases for ReplicationProviderSpecificContainerCreationInput.

ReplicationProviderSpecificContainerMappingInputUnion

ReplicationProviderSpecificContainerMappingInputUnion: ReplicationProviderSpecificContainerMappingInput | A2AContainerMappingInput

Contains the possible cases for ReplicationProviderSpecificContainerMappingInput.

ReplicationProviderSpecificSettingsUnion

Contains the possible cases for ReplicationProviderSpecificSettings.

ReplicationProviderSpecificUpdateContainerMappingInputUnion

ReplicationProviderSpecificUpdateContainerMappingInputUnion: ReplicationProviderSpecificUpdateContainerMappingInput | A2AUpdateContainerMappingInput

Contains the possible cases for ReplicationProviderSpecificUpdateContainerMappingInput.

ReplicationRecoveryPlansBeginCreateResponse

ReplicationRecoveryPlansBeginCreateResponse: RecoveryPlan & object

Contains response data for the beginCreate operation.

ReplicationRecoveryPlansBeginFailoverCommitResponse

ReplicationRecoveryPlansBeginFailoverCommitResponse: RecoveryPlan & object

Contains response data for the beginFailoverCommit operation.

ReplicationRecoveryPlansBeginPlannedFailoverResponse

ReplicationRecoveryPlansBeginPlannedFailoverResponse: RecoveryPlan & object

Contains response data for the beginPlannedFailover operation.

ReplicationRecoveryPlansBeginReprotectResponse

ReplicationRecoveryPlansBeginReprotectResponse: RecoveryPlan & object

Contains response data for the beginReprotect operation.

ReplicationRecoveryPlansBeginTestFailoverCleanupResponse

ReplicationRecoveryPlansBeginTestFailoverCleanupResponse: RecoveryPlan & object

Contains response data for the beginTestFailoverCleanup operation.

ReplicationRecoveryPlansBeginTestFailoverResponse

ReplicationRecoveryPlansBeginTestFailoverResponse: RecoveryPlan & object

Contains response data for the beginTestFailover operation.

ReplicationRecoveryPlansBeginUnplannedFailoverResponse

ReplicationRecoveryPlansBeginUnplannedFailoverResponse: RecoveryPlan & object

Contains response data for the beginUnplannedFailover operation.

ReplicationRecoveryPlansBeginUpdateResponse

ReplicationRecoveryPlansBeginUpdateResponse: RecoveryPlan & object

Contains response data for the beginUpdate operation.

ReplicationRecoveryPlansCreateResponse

ReplicationRecoveryPlansCreateResponse: RecoveryPlan & object

Contains response data for the create operation.

ReplicationRecoveryPlansFailoverCommitResponse

ReplicationRecoveryPlansFailoverCommitResponse: RecoveryPlan & object

Contains response data for the failoverCommit operation.

ReplicationRecoveryPlansGetResponse

ReplicationRecoveryPlansGetResponse: RecoveryPlan & object

Contains response data for the get operation.

ReplicationRecoveryPlansListNextResponse

ReplicationRecoveryPlansListNextResponse: RecoveryPlanCollection & object

Contains response data for the listNext operation.

ReplicationRecoveryPlansListResponse

ReplicationRecoveryPlansListResponse: RecoveryPlanCollection & object

Contains response data for the list operation.

ReplicationRecoveryPlansPlannedFailoverResponse

ReplicationRecoveryPlansPlannedFailoverResponse: RecoveryPlan & object

Contains response data for the plannedFailover operation.

ReplicationRecoveryPlansReprotectResponse

ReplicationRecoveryPlansReprotectResponse: RecoveryPlan & object

Contains response data for the reprotect operation.

ReplicationRecoveryPlansTestFailoverCleanupResponse

ReplicationRecoveryPlansTestFailoverCleanupResponse: RecoveryPlan & object

Contains response data for the testFailoverCleanup operation.

ReplicationRecoveryPlansTestFailoverResponse

ReplicationRecoveryPlansTestFailoverResponse: RecoveryPlan & object

Contains response data for the testFailover operation.

ReplicationRecoveryPlansUnplannedFailoverResponse

ReplicationRecoveryPlansUnplannedFailoverResponse: RecoveryPlan & object

Contains response data for the unplannedFailover operation.

ReplicationRecoveryPlansUpdateResponse

ReplicationRecoveryPlansUpdateResponse: RecoveryPlan & object

Contains response data for the update operation.

ReplicationRecoveryServicesProvidersBeginRefreshProviderResponse

ReplicationRecoveryServicesProvidersBeginRefreshProviderResponse: RecoveryServicesProvider & object

Contains response data for the beginRefreshProvider operation.

ReplicationRecoveryServicesProvidersGetResponse

ReplicationRecoveryServicesProvidersGetResponse: RecoveryServicesProvider & object

Contains response data for the get operation.

ReplicationRecoveryServicesProvidersListByReplicationFabricsNextResponse

ReplicationRecoveryServicesProvidersListByReplicationFabricsNextResponse: RecoveryServicesProviderCollection & object

Contains response data for the listByReplicationFabricsNext operation.

ReplicationRecoveryServicesProvidersListByReplicationFabricsResponse

ReplicationRecoveryServicesProvidersListByReplicationFabricsResponse: RecoveryServicesProviderCollection & object

Contains response data for the listByReplicationFabrics operation.

ReplicationRecoveryServicesProvidersListNextResponse

ReplicationRecoveryServicesProvidersListNextResponse: RecoveryServicesProviderCollection & object

Contains response data for the listNext operation.

ReplicationRecoveryServicesProvidersListResponse

ReplicationRecoveryServicesProvidersListResponse: RecoveryServicesProviderCollection & object

Contains response data for the list operation.

ReplicationRecoveryServicesProvidersRefreshProviderResponse

ReplicationRecoveryServicesProvidersRefreshProviderResponse: RecoveryServicesProvider & object

Contains response data for the refreshProvider operation.

ReplicationStorageClassificationMappingsBeginCreateResponse

ReplicationStorageClassificationMappingsBeginCreateResponse: StorageClassificationMapping & object

Contains response data for the beginCreate operation.

ReplicationStorageClassificationMappingsCreateResponse

ReplicationStorageClassificationMappingsCreateResponse: StorageClassificationMapping & object

Contains response data for the create operation.

ReplicationStorageClassificationMappingsGetResponse

ReplicationStorageClassificationMappingsGetResponse: StorageClassificationMapping & object

Contains response data for the get operation.

ReplicationStorageClassificationMappingsListByReplicationStorageClassificationsNextResponse

ReplicationStorageClassificationMappingsListByReplicationStorageClassificationsNextResponse: StorageClassificationMappingCollection & object

Contains response data for the listByReplicationStorageClassificationsNext operation.

ReplicationStorageClassificationMappingsListByReplicationStorageClassificationsResponse

ReplicationStorageClassificationMappingsListByReplicationStorageClassificationsResponse: StorageClassificationMappingCollection & object

Contains response data for the listByReplicationStorageClassifications operation.

ReplicationStorageClassificationMappingsListNextResponse

ReplicationStorageClassificationMappingsListNextResponse: StorageClassificationMappingCollection & object

Contains response data for the listNext operation.

ReplicationStorageClassificationMappingsListResponse

ReplicationStorageClassificationMappingsListResponse: StorageClassificationMappingCollection & object

Contains response data for the list operation.

ReplicationStorageClassificationsGetResponse

ReplicationStorageClassificationsGetResponse: StorageClassification & object

Contains response data for the get operation.

ReplicationStorageClassificationsListByReplicationFabricsNextResponse

ReplicationStorageClassificationsListByReplicationFabricsNextResponse: StorageClassificationCollection & object

Contains response data for the listByReplicationFabricsNext operation.

ReplicationStorageClassificationsListByReplicationFabricsResponse

ReplicationStorageClassificationsListByReplicationFabricsResponse: StorageClassificationCollection & object

Contains response data for the listByReplicationFabrics operation.

ReplicationStorageClassificationsListNextResponse

ReplicationStorageClassificationsListNextResponse: StorageClassificationCollection & object

Contains response data for the listNext operation.

ReplicationStorageClassificationsListResponse

ReplicationStorageClassificationsListResponse: StorageClassificationCollection & object

Contains response data for the list operation.

ReplicationVaultHealthBeginRefreshResponse

ReplicationVaultHealthBeginRefreshResponse: VaultHealthDetails & object

Contains response data for the beginRefresh operation.

ReplicationVaultHealthGetResponse

ReplicationVaultHealthGetResponse: VaultHealthDetails & object

Contains response data for the get operation.

ReplicationVaultHealthRefreshResponse

ReplicationVaultHealthRefreshResponse: VaultHealthDetails & object

Contains response data for the refresh operation.

ReplicationvCentersBeginCreateResponse

ReplicationvCentersBeginCreateResponse: VCenter & object

Contains response data for the beginCreate operation.

ReplicationvCentersBeginUpdateResponse

ReplicationvCentersBeginUpdateResponse: VCenter & object

Contains response data for the beginUpdate operation.

ReplicationvCentersCreateResponse

ReplicationvCentersCreateResponse: VCenter & object

Contains response data for the create operation.

ReplicationvCentersGetResponse

ReplicationvCentersGetResponse: VCenter & object

Contains response data for the get operation.

ReplicationvCentersListByReplicationFabricsNextResponse

ReplicationvCentersListByReplicationFabricsNextResponse: VCenterCollection & object

Contains response data for the listByReplicationFabricsNext operation.

ReplicationvCentersListByReplicationFabricsResponse

ReplicationvCentersListByReplicationFabricsResponse: VCenterCollection & object

Contains response data for the listByReplicationFabrics operation.

ReplicationvCentersListNextResponse

ReplicationvCentersListNextResponse: VCenterCollection & object

Contains response data for the listNext operation.

ReplicationvCentersListResponse

ReplicationvCentersListResponse: VCenterCollection & object

Contains response data for the list operation.

ReplicationvCentersUpdateResponse

ReplicationvCentersUpdateResponse: VCenter & object

Contains response data for the update operation.

ReverseReplicationProviderSpecificInputUnion

Contains the possible cases for ReverseReplicationProviderSpecificInput.

RpInMageRecoveryPointType

RpInMageRecoveryPointType: "LatestTime" | "LatestTag" | "Custom"

Defines values for RpInMageRecoveryPointType. Possible values include: 'LatestTime', 'LatestTag', 'Custom'

readonly
enum

{string}

SetMultiVmSyncStatus

SetMultiVmSyncStatus: "Enable" | "Disable"

Defines values for SetMultiVmSyncStatus. Possible values include: 'Enable', 'Disable'

readonly
enum

{string}

Severity

Severity: "NONE" | "Warning" | "Error" | "Info"

Defines values for Severity. Possible values include: 'NONE', 'Warning', 'Error', 'Info'

readonly
enum

{string}

SourceSiteOperations

SourceSiteOperations: "Required" | "NotRequired"

Defines values for SourceSiteOperations. Possible values include: 'Required', 'NotRequired'

readonly
enum

{string}

SwitchProtectionProviderSpecificInputUnion

SwitchProtectionProviderSpecificInputUnion: SwitchProtectionProviderSpecificInput | A2ASwitchProtectionInput

Contains the possible cases for SwitchProtectionProviderSpecificInput.

TargetComputeSizesListByReplicationProtectedItemsNextResponse

TargetComputeSizesListByReplicationProtectedItemsNextResponse: TargetComputeSizeCollection & object

Contains response data for the listByReplicationProtectedItemsNext operation.

TargetComputeSizesListByReplicationProtectedItemsResponse

TargetComputeSizesListByReplicationProtectedItemsResponse: TargetComputeSizeCollection & object

Contains response data for the listByReplicationProtectedItems operation.

TaskTypeDetailsUnion

Contains the possible cases for TaskTypeDetails.

UpdateReplicationProtectedItemProviderInputUnion

Contains the possible cases for UpdateReplicationProtectedItemProviderInput.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const A2AApplyRecoveryPointInput

A2AApplyRecoveryPointInput: object
interface

An interface representing A2AApplyRecoveryPointInput. ApplyRecoveryPoint input specific to A2A provider.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AApplyRecoveryPointInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ApplyRecoveryPointProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ApplyRecoveryPointProviderSpecificInput"

modelProperties

modelProperties: object

Const A2AContainerCreationInput

A2AContainerCreationInput: object
interface

An interface representing A2AContainerCreationInput. A2A cloud creation input.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AContainerCreationInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificContainerCreationInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificContainerCreationInput"

modelProperties

modelProperties: object

Const A2AContainerMappingInput

A2AContainerMappingInput: object
interface

An interface representing A2AContainerMappingInput. A2A container mapping input.

Optional agentAutoUpdateStatus

agentAutoUpdateStatus: AgentAutoUpdateStatus
member

{AgentAutoUpdateStatus} [agentAutoUpdateStatus] A value indicating whether the auto update is enabled. Possible values include: 'Disabled', 'Enabled'

Optional automationAccountArmId

automationAccountArmId: undefined | string
member

{string} [automationAccountArmId] The automation account arm id.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AContainerMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificContainerMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificContainerMappingInput"

modelProperties

modelProperties: object

agentAutoUpdateStatus

agentAutoUpdateStatus: object

serializedName

serializedName: string = "agentAutoUpdateStatus"

type

type: object

name

name: "String" = "String"

automationAccountArmId

automationAccountArmId: object

serializedName

serializedName: string = "automationAccountArmId"

type

type: object

name

name: "String" = "String"

Const A2AEnableProtectionInput

A2AEnableProtectionInput: object
interface

An interface representing A2AEnableProtectionInput. A2A enable protection input.

Optional diskEncryptionInfo

diskEncryptionInfo: DiskEncryptionInfo
member

{DiskEncryptionInfo} [diskEncryptionInfo] The recovery disk encryption information.

Optional fabricObjectId

fabricObjectId: undefined | string
member

{string} [fabricObjectId] The fabric specific object Id of the virtual machine.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmGroupName

multiVmGroupName: undefined | string
member

{string} [multiVmGroupName] The multi vm group name.

Optional recoveryAvailabilitySetId

recoveryAvailabilitySetId: undefined | string
member

{string} [recoveryAvailabilitySetId] The recovery availability set Id.

Optional recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: undefined | string
member

{string} [recoveryBootDiagStorageAccountId] The boot diagnostic storage account.

Optional recoveryCloudServiceId

recoveryCloudServiceId: undefined | string
member

{string} [recoveryCloudServiceId] The recovery cloud service Id. Valid for V1 scenarios.

Optional recoveryContainerId

recoveryContainerId: undefined | string
member

{string} [recoveryContainerId] The recovery container Id.

Optional recoveryResourceGroupId

recoveryResourceGroupId: undefined | string
member

{string} [recoveryResourceGroupId] The recovery resource group Id. Valid for V2 scenarios.

Optional vmDisks

member

{A2AVmDiskInputDetails[]} [vmDisks] The list of vm disk details.

Optional vmManagedDisks

member

{A2AVmManagedDiskInputDetails[]} [vmManagedDisks] The list of vm managed disk details.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AEnableProtectionInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EnableProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "EnableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

diskEncryptionInfo

diskEncryptionInfo: object

serializedName

serializedName: string = "diskEncryptionInfo"

type

type: object

className

className: string = "DiskEncryptionInfo"

name

name: "Composite" = "Composite"

fabricObjectId

fabricObjectId: object

serializedName

serializedName: string = "fabricObjectId"

type

type: object

name

name: "String" = "String"

multiVmGroupName

multiVmGroupName: object

serializedName

serializedName: string = "multiVmGroupName"

type

type: object

name

name: "String" = "String"

recoveryAvailabilitySetId

recoveryAvailabilitySetId: object

serializedName

serializedName: string = "recoveryAvailabilitySetId"

type

type: object

name

name: "String" = "String"

recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: object

serializedName

serializedName: string = "recoveryBootDiagStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryCloudServiceId

recoveryCloudServiceId: object

serializedName

serializedName: string = "recoveryCloudServiceId"

type

type: object

name

name: "String" = "String"

recoveryContainerId

recoveryContainerId: object

serializedName

serializedName: string = "recoveryContainerId"

type

type: object

name

name: "String" = "String"

recoveryResourceGroupId

recoveryResourceGroupId: object

serializedName

serializedName: string = "recoveryResourceGroupId"

type

type: object

name

name: "String" = "String"

vmDisks

vmDisks: object

serializedName

serializedName: string = "vmDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AVmDiskInputDetails"

name

name: "Composite" = "Composite"

vmManagedDisks

vmManagedDisks: object

serializedName

serializedName: string = "vmManagedDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AVmManagedDiskInputDetails"

name

name: "Composite" = "Composite"

Const A2AEventDetails

A2AEventDetails: object
interface

An interface representing A2AEventDetails. Model class for event details of a A2A event.

Optional fabricLocation

fabricLocation: undefined | string
member

{string} [fabricLocation] The fabric location.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Fabric arm name.

Optional fabricObjectId

fabricObjectId: undefined | string
member

{string} [fabricObjectId] The azure vm arm id.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional protectedItemName

protectedItemName: undefined | string
member

{string} [protectedItemName] The protected item arm name.

Optional remoteFabricLocation

remoteFabricLocation: undefined | string
member

{string} [remoteFabricLocation] Remote fabric location.

Optional remoteFabricName

remoteFabricName: undefined | string
member

{string} [remoteFabricName] Remote fabric arm name.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AEventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

fabricLocation

fabricLocation: object

serializedName

serializedName: string = "fabricLocation"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

fabricObjectId

fabricObjectId: object

serializedName

serializedName: string = "fabricObjectId"

type

type: object

name

name: "String" = "String"

protectedItemName

protectedItemName: object

serializedName

serializedName: string = "protectedItemName"

type

type: object

name

name: "String" = "String"

remoteFabricLocation

remoteFabricLocation: object

serializedName

serializedName: string = "remoteFabricLocation"

type

type: object

name

name: "String" = "String"

remoteFabricName

remoteFabricName: object

serializedName

serializedName: string = "remoteFabricName"

type

type: object

name

name: "String" = "String"

Const A2AFailoverProviderInput

A2AFailoverProviderInput: object
interface

An interface representing A2AFailoverProviderInput. A2A provider specific input for failover.

Optional cloudServiceCreationOption

cloudServiceCreationOption: undefined | string
member

{string} [cloudServiceCreationOption] A value indicating whether to use recovery cloud service for TFO or not.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AFailoverProviderInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificFailoverInput"

modelProperties

modelProperties: object

cloudServiceCreationOption

cloudServiceCreationOption: object

serializedName

serializedName: string = "cloudServiceCreationOption"

type

type: object

name

name: "String" = "String"

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

Const A2APolicyCreationInput

A2APolicyCreationInput: object
interface

An interface representing A2APolicyCreationInput. A2A Policy creation input.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency (in minutes).

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency (in minutes).

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

multiVmSyncStatus

multiVmSyncStatus: SetMultiVmSyncStatus
member

{SetMultiVmSyncStatus} multiVmSyncStatus A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. Possible values include: 'Enable', 'Disable'

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2APolicyCreationInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

required

required: true = true

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

Const A2APolicyDetails

A2APolicyDetails: object
interface

An interface representing A2APolicyDetails. A2A specific policy details.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency in minutes.

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency in minutes.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmSyncStatus

multiVmSyncStatus: undefined | string
member

{string} [multiVmSyncStatus] A value indicating whether multi-VM sync has to be enabled.

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2APolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const A2AProtectedDiskDetails

A2AProtectedDiskDetails: object
interface

An interface representing A2AProtectedDiskDetails. A2A protected disk details.

Optional dataPendingAtSourceAgentInMB

dataPendingAtSourceAgentInMB: undefined | number
member

{number} [dataPendingAtSourceAgentInMB] The data pending at source virtual machine in MB.

Optional dataPendingInStagingStorageAccountInMB

dataPendingInStagingStorageAccountInMB: undefined | number
member

{number} [dataPendingInStagingStorageAccountInMB] The data pending for replication in MB at staging account.

Optional dekKeyVaultArmId

dekKeyVaultArmId: undefined | string
member

{string} [dekKeyVaultArmId] The KeyVault resource id for secret (BEK).

Optional diskCapacityInBytes

diskCapacityInBytes: undefined | number
member

{number} [diskCapacityInBytes] The disk capacity in bytes.

Optional diskName

diskName: undefined | string
member

{string} [diskName] The disk name.

Optional diskType

diskType: undefined | string
member

{string} [diskType] The type of disk.

Optional diskUri

diskUri: undefined | string
member

{string} [diskUri] The disk uri.

Optional isDiskEncrypted

isDiskEncrypted: undefined | false | true
member

{boolean} [isDiskEncrypted] A value indicating whether vm has encrypted os disk or not.

Optional isDiskKeyEncrypted

isDiskKeyEncrypted: undefined | false | true
member

{boolean} [isDiskKeyEncrypted] A value indicating whether disk key got encrypted or not.

Optional kekKeyVaultArmId

kekKeyVaultArmId: undefined | string
member

{string} [kekKeyVaultArmId] The KeyVault resource id for key (KEK).

Optional keyIdentifier

keyIdentifier: undefined | string
member

{string} [keyIdentifier] The key URL / identifier (KEK).

Optional monitoringJobType

monitoringJobType: undefined | string
member

{string} [monitoringJobType] The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.

Optional monitoringPercentageCompletion

monitoringPercentageCompletion: undefined | number
member

{number} [monitoringPercentageCompletion] The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.

Optional primaryDiskAzureStorageAccountId

primaryDiskAzureStorageAccountId: undefined | string
member

{string} [primaryDiskAzureStorageAccountId] The primary disk storage account.

Optional primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: undefined | string
member

{string} [primaryStagingAzureStorageAccountId] The primary staging storage account.

Optional recoveryAzureStorageAccountId

recoveryAzureStorageAccountId: undefined | string
member

{string} [recoveryAzureStorageAccountId] The recovery disk storage account.

Optional recoveryDiskUri

recoveryDiskUri: undefined | string
member

{string} [recoveryDiskUri] Recovery disk uri.

Optional resyncRequired

resyncRequired: undefined | false | true
member

{boolean} [resyncRequired] A value indicating whether resync is required for this disk.

Optional secretIdentifier

secretIdentifier: undefined | string
member

{string} [secretIdentifier] The secret URL / identifier (BEK).

serializedName

serializedName: string = "A2AProtectedDiskDetails"

type

type: object

className

className: string = "A2AProtectedDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataPendingAtSourceAgentInMB

dataPendingAtSourceAgentInMB: object

serializedName

serializedName: string = "dataPendingAtSourceAgentInMB"

type

type: object

name

name: "Number" = "Number"

dataPendingInStagingStorageAccountInMB

dataPendingInStagingStorageAccountInMB: object

serializedName

serializedName: string = "dataPendingInStagingStorageAccountInMB"

type

type: object

name

name: "Number" = "Number"

dekKeyVaultArmId

dekKeyVaultArmId: object

serializedName

serializedName: string = "dekKeyVaultArmId"

type

type: object

name

name: "String" = "String"

diskCapacityInBytes

diskCapacityInBytes: object

serializedName

serializedName: string = "diskCapacityInBytes"

type

type: object

name

name: "Number" = "Number"

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskType

diskType: object

serializedName

serializedName: string = "diskType"

type

type: object

name

name: "String" = "String"

diskUri

diskUri: object

serializedName

serializedName: string = "diskUri"

type

type: object

name

name: "String" = "String"

isDiskEncrypted

isDiskEncrypted: object

serializedName

serializedName: string = "isDiskEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

isDiskKeyEncrypted

isDiskKeyEncrypted: object

serializedName

serializedName: string = "isDiskKeyEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

kekKeyVaultArmId

kekKeyVaultArmId: object

serializedName

serializedName: string = "kekKeyVaultArmId"

type

type: object

name

name: "String" = "String"

keyIdentifier

keyIdentifier: object

serializedName

serializedName: string = "keyIdentifier"

type

type: object

name

name: "String" = "String"

monitoringJobType

monitoringJobType: object

serializedName

serializedName: string = "monitoringJobType"

type

type: object

name

name: "String" = "String"

monitoringPercentageCompletion

monitoringPercentageCompletion: object

serializedName

serializedName: string = "monitoringPercentageCompletion"

type

type: object

name

name: "Number" = "Number"

primaryDiskAzureStorageAccountId

primaryDiskAzureStorageAccountId: object

serializedName

serializedName: string = "primaryDiskAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: object

serializedName

serializedName: string = "primaryStagingAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryAzureStorageAccountId

recoveryAzureStorageAccountId: object

serializedName

serializedName: string = "recoveryAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryDiskUri

recoveryDiskUri: object

serializedName

serializedName: string = "recoveryDiskUri"

type

type: object

name

name: "String" = "String"

resyncRequired

resyncRequired: object

serializedName

serializedName: string = "resyncRequired"

type

type: object

name

name: "Boolean" = "Boolean"

secretIdentifier

secretIdentifier: object

serializedName

serializedName: string = "secretIdentifier"

type

type: object

name

name: "String" = "String"

Const A2AProtectedManagedDiskDetails

A2AProtectedManagedDiskDetails: object
interface

An interface representing A2AProtectedManagedDiskDetails. A2A protected managed disk details.

Optional dataPendingAtSourceAgentInMB

dataPendingAtSourceAgentInMB: undefined | number
member

{number} [dataPendingAtSourceAgentInMB] The data pending at source virtual machine in MB.

Optional dataPendingInStagingStorageAccountInMB

dataPendingInStagingStorageAccountInMB: undefined | number
member

{number} [dataPendingInStagingStorageAccountInMB] The data pending for replication in MB at staging account.

Optional dekKeyVaultArmId

dekKeyVaultArmId: undefined | string
member

{string} [dekKeyVaultArmId] The KeyVault resource id for secret (BEK).

Optional diskCapacityInBytes

diskCapacityInBytes: undefined | number
member

{number} [diskCapacityInBytes] The disk capacity in bytes.

Optional diskId

diskId: undefined | string
member

{string} [diskId] The managed disk Arm id.

Optional diskName

diskName: undefined | string
member

{string} [diskName] The disk name.

Optional diskType

diskType: undefined | string
member

{string} [diskType] The type of disk.

Optional isDiskEncrypted

isDiskEncrypted: undefined | false | true
member

{boolean} [isDiskEncrypted] A value indicating whether vm has encrypted os disk or not.

Optional isDiskKeyEncrypted

isDiskKeyEncrypted: undefined | false | true
member

{boolean} [isDiskKeyEncrypted] A value indicating whether disk key got encrypted or not.

Optional kekKeyVaultArmId

kekKeyVaultArmId: undefined | string
member

{string} [kekKeyVaultArmId] The KeyVault resource id for key (KEK).

Optional keyIdentifier

keyIdentifier: undefined | string
member

{string} [keyIdentifier] The key URL / identifier (KEK).

Optional monitoringJobType

monitoringJobType: undefined | string
member

{string} [monitoringJobType] The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.

Optional monitoringPercentageCompletion

monitoringPercentageCompletion: undefined | number
member

{number} [monitoringPercentageCompletion] The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.

Optional primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: undefined | string
member

{string} [primaryStagingAzureStorageAccountId] The primary staging storage account.

Optional recoveryReplicaDiskAccountType

recoveryReplicaDiskAccountType: undefined | string
member

{string} [recoveryReplicaDiskAccountType] The replica disk type. Its an optional value and will be same as source disk type if not user provided.

Optional recoveryReplicaDiskId

recoveryReplicaDiskId: undefined | string
member

{string} [recoveryReplicaDiskId] Recovery replica disk Arm Id.

Optional recoveryResourceGroupId

recoveryResourceGroupId: undefined | string
member

{string} [recoveryResourceGroupId] The recovery disk resource group Arm Id.

Optional recoveryTargetDiskAccountType

recoveryTargetDiskAccountType: undefined | string
member

{string} [recoveryTargetDiskAccountType] The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.

Optional recoveryTargetDiskId

recoveryTargetDiskId: undefined | string
member

{string} [recoveryTargetDiskId] Recovery target disk Arm Id.

Optional resyncRequired

resyncRequired: undefined | false | true
member

{boolean} [resyncRequired] A value indicating whether resync is required for this disk.

Optional secretIdentifier

secretIdentifier: undefined | string
member

{string} [secretIdentifier] The secret URL / identifier (BEK).

serializedName

serializedName: string = "A2AProtectedManagedDiskDetails"

type

type: object

className

className: string = "A2AProtectedManagedDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataPendingAtSourceAgentInMB

dataPendingAtSourceAgentInMB: object

serializedName

serializedName: string = "dataPendingAtSourceAgentInMB"

type

type: object

name

name: "Number" = "Number"

dataPendingInStagingStorageAccountInMB

dataPendingInStagingStorageAccountInMB: object

serializedName

serializedName: string = "dataPendingInStagingStorageAccountInMB"

type

type: object

name

name: "Number" = "Number"

dekKeyVaultArmId

dekKeyVaultArmId: object

serializedName

serializedName: string = "dekKeyVaultArmId"

type

type: object

name

name: "String" = "String"

diskCapacityInBytes

diskCapacityInBytes: object

serializedName

serializedName: string = "diskCapacityInBytes"

type

type: object

name

name: "Number" = "Number"

diskId

diskId: object

serializedName

serializedName: string = "diskId"

type

type: object

name

name: "String" = "String"

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskType

diskType: object

serializedName

serializedName: string = "diskType"

type

type: object

name

name: "String" = "String"

isDiskEncrypted

isDiskEncrypted: object

serializedName

serializedName: string = "isDiskEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

isDiskKeyEncrypted

isDiskKeyEncrypted: object

serializedName

serializedName: string = "isDiskKeyEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

kekKeyVaultArmId

kekKeyVaultArmId: object

serializedName

serializedName: string = "kekKeyVaultArmId"

type

type: object

name

name: "String" = "String"

keyIdentifier

keyIdentifier: object

serializedName

serializedName: string = "keyIdentifier"

type

type: object

name

name: "String" = "String"

monitoringJobType

monitoringJobType: object

serializedName

serializedName: string = "monitoringJobType"

type

type: object

name

name: "String" = "String"

monitoringPercentageCompletion

monitoringPercentageCompletion: object

serializedName

serializedName: string = "monitoringPercentageCompletion"

type

type: object

name

name: "Number" = "Number"

primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: object

serializedName

serializedName: string = "primaryStagingAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryReplicaDiskAccountType

recoveryReplicaDiskAccountType: object

serializedName

serializedName: string = "recoveryReplicaDiskAccountType"

type

type: object

name

name: "String" = "String"

recoveryReplicaDiskId

recoveryReplicaDiskId: object

serializedName

serializedName: string = "recoveryReplicaDiskId"

type

type: object

name

name: "String" = "String"

recoveryResourceGroupId

recoveryResourceGroupId: object

serializedName

serializedName: string = "recoveryResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryTargetDiskAccountType

recoveryTargetDiskAccountType: object

serializedName

serializedName: string = "recoveryTargetDiskAccountType"

type

type: object

name

name: "String" = "String"

recoveryTargetDiskId

recoveryTargetDiskId: object

serializedName

serializedName: string = "recoveryTargetDiskId"

type

type: object

name

name: "String" = "String"

resyncRequired

resyncRequired: object

serializedName

serializedName: string = "resyncRequired"

type

type: object

name

name: "Boolean" = "Boolean"

secretIdentifier

secretIdentifier: object

serializedName

serializedName: string = "secretIdentifier"

type

type: object

name

name: "String" = "String"

Const A2AProtectionContainerMappingDetails

A2AProtectionContainerMappingDetails: object
interface

An interface representing A2AProtectionContainerMappingDetails. A2A provider specific settings.

Optional agentAutoUpdateStatus

agentAutoUpdateStatus: AgentAutoUpdateStatus
member

{AgentAutoUpdateStatus} [agentAutoUpdateStatus] A value indicating whether the auto update is enabled. Possible values include: 'Disabled', 'Enabled'

Optional automationAccountArmId

automationAccountArmId: undefined | string
member

{string} [automationAccountArmId] The automation account arm id.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional jobScheduleName

jobScheduleName: undefined | string
member

{string} [jobScheduleName] The job schedule arm name.

Optional scheduleName

scheduleName: undefined | string
member

{string} [scheduleName] The schedule arm name.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AProtectionContainerMappingDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainerMappingProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainerMappingProviderSpecificDetails"

modelProperties

modelProperties: object

agentAutoUpdateStatus

agentAutoUpdateStatus: object

serializedName

serializedName: string = "agentAutoUpdateStatus"

type

type: object

name

name: "String" = "String"

automationAccountArmId

automationAccountArmId: object

serializedName

serializedName: string = "automationAccountArmId"

type

type: object

name

name: "String" = "String"

jobScheduleName

jobScheduleName: object

serializedName

serializedName: string = "jobScheduleName"

type

type: object

name

name: "String" = "String"

scheduleName

scheduleName: object

serializedName

serializedName: string = "scheduleName"

type

type: object

name

name: "String" = "String"

Const A2ARecoveryPointDetails

A2ARecoveryPointDetails: object
interface

An interface representing A2ARecoveryPointDetails. A2A provider specific recovery point details.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryPointSyncType

recoveryPointSyncType: RecoveryPointSyncType
member

{RecoveryPointSyncType} [recoveryPointSyncType] A value indicating whether the recovery point is multi VM consistent. Possible values include: 'MultiVmSyncRecoveryPoint', 'PerVmRecoveryPoint'

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2ARecoveryPointDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificRecoveryPointDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificRecoveryPointDetails"

modelProperties

modelProperties: object

recoveryPointSyncType

recoveryPointSyncType: object

serializedName

serializedName: string = "recoveryPointSyncType"

type

type: object

name

name: "String" = "String"

Const A2AReplicationDetails

A2AReplicationDetails: object
interface

An interface representing A2AReplicationDetails. A2A provider specific settings.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The agent version.

Optional fabricObjectId

fabricObjectId: undefined | string
member

{string} [fabricObjectId] The fabric specific object Id of the virtual machine.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional isReplicationAgentUpdateRequired

isReplicationAgentUpdateRequired: undefined | false | true
member

{boolean} [isReplicationAgentUpdateRequired] A value indicating whether replication agent update is required.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The last heartbeat received from the source server.

Optional lastRpoCalculatedTime

lastRpoCalculatedTime: Date
member

{Date} [lastRpoCalculatedTime] The time (in UTC) when the last RPO value was calculated by Protection Service.

Optional lifecycleId

lifecycleId: undefined | string
member

{string} [lifecycleId] An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the "same" protected item even though other internal Ids/ARM Id might be changing.

Optional managementId

managementId: undefined | string
member

{string} [managementId] The management Id.

Optional monitoringJobType

monitoringJobType: undefined | string
member

{string} [monitoringJobType] The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.

Optional monitoringPercentageCompletion

monitoringPercentageCompletion: undefined | number
member

{number} [monitoringPercentageCompletion] The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.

Optional multiVmGroupCreateOption

multiVmGroupCreateOption: MultiVmGroupCreateOption
member

{MultiVmGroupCreateOption} [multiVmGroupCreateOption] Whether Multi VM group is auto created or specified by user. Possible values include: 'AutoCreated', 'UserSpecified'

Optional multiVmGroupId

multiVmGroupId: undefined | string
member

{string} [multiVmGroupId] The multi vm group Id.

Optional multiVmGroupName

multiVmGroupName: undefined | string
member

{string} [multiVmGroupName] The multi vm group name.

Optional osType

osType: undefined | string
member

{string} [osType] The type of operating system.

Optional primaryFabricLocation

primaryFabricLocation: undefined | string
member

{string} [primaryFabricLocation] Primary fabric location.

Optional protectedDisks

protectedDisks: A2AProtectedDiskDetails[]
member

{A2AProtectedDiskDetails[]} [protectedDisks] The list of protected disks.

Optional protectedManagedDisks

protectedManagedDisks: A2AProtectedManagedDiskDetails[]
member

{A2AProtectedManagedDiskDetails[]} [protectedManagedDisks] The list of protected managed disks.

Optional recoveryAvailabilitySet

recoveryAvailabilitySet: undefined | string
member

{string} [recoveryAvailabilitySet] The recovery availability set.

Optional recoveryAzureResourceGroupId

recoveryAzureResourceGroupId: undefined | string
member

{string} [recoveryAzureResourceGroupId] The recovery resource group.

Optional recoveryAzureVMName

recoveryAzureVMName: undefined | string
member

{string} [recoveryAzureVMName] The name of recovery virtual machine.

Optional recoveryAzureVMSize

recoveryAzureVMSize: undefined | string
member

{string} [recoveryAzureVMSize] The size of recovery virtual machine.

Optional recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: undefined | string
member

{string} [recoveryBootDiagStorageAccountId] The recovery boot diagnostic storage account Arm Id.

Optional recoveryCloudService

recoveryCloudService: undefined | string
member

{string} [recoveryCloudService] The recovery cloud service.

Optional recoveryFabricLocation

recoveryFabricLocation: undefined | string
member

{string} [recoveryFabricLocation] The recovery fabric location.

Optional recoveryFabricObjectId

recoveryFabricObjectId: undefined | string
member

{string} [recoveryFabricObjectId] The recovery fabric object Id.

Optional rpoInSeconds

rpoInSeconds: undefined | number
member

{number} [rpoInSeconds] The last RPO value in seconds.

Optional selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: undefined | string
member

{string} [selectedRecoveryAzureNetworkId] The recovery virtual network.

Optional testFailoverRecoveryFabricObjectId

testFailoverRecoveryFabricObjectId: undefined | string
member

{string} [testFailoverRecoveryFabricObjectId] The test failover fabric object Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The virtual machine nic details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

Optional vmSyncedConfigDetails

vmSyncedConfigDetails: AzureToAzureVmSyncedConfigDetails
member

{AzureToAzureVmSyncedConfigDetails} [vmSyncedConfigDetails] The synced configuration details.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

fabricObjectId

fabricObjectId: object

serializedName

serializedName: string = "fabricObjectId"

type

type: object

name

name: "String" = "String"

isReplicationAgentUpdateRequired

isReplicationAgentUpdateRequired: object

serializedName

serializedName: string = "isReplicationAgentUpdateRequired"

type

type: object

name

name: "Boolean" = "Boolean"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

lastRpoCalculatedTime

lastRpoCalculatedTime: object

serializedName

serializedName: string = "lastRpoCalculatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lifecycleId

lifecycleId: object

serializedName

serializedName: string = "lifecycleId"

type

type: object

name

name: "String" = "String"

managementId

managementId: object

serializedName

serializedName: string = "managementId"

type

type: object

name

name: "String" = "String"

monitoringJobType

monitoringJobType: object

serializedName

serializedName: string = "monitoringJobType"

type

type: object

name

name: "String" = "String"

monitoringPercentageCompletion

monitoringPercentageCompletion: object

serializedName

serializedName: string = "monitoringPercentageCompletion"

type

type: object

name

name: "Number" = "Number"

multiVmGroupCreateOption

multiVmGroupCreateOption: object

serializedName

serializedName: string = "multiVmGroupCreateOption"

type

type: object

name

name: "String" = "String"

multiVmGroupId

multiVmGroupId: object

serializedName

serializedName: string = "multiVmGroupId"

type

type: object

name

name: "String" = "String"

multiVmGroupName

multiVmGroupName: object

serializedName

serializedName: string = "multiVmGroupName"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

primaryFabricLocation

primaryFabricLocation: object

serializedName

serializedName: string = "primaryFabricLocation"

type

type: object

name

name: "String" = "String"

protectedDisks

protectedDisks: object

serializedName

serializedName: string = "protectedDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AProtectedDiskDetails"

name

name: "Composite" = "Composite"

protectedManagedDisks

protectedManagedDisks: object

serializedName

serializedName: string = "protectedManagedDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AProtectedManagedDiskDetails"

name

name: "Composite" = "Composite"

recoveryAvailabilitySet

recoveryAvailabilitySet: object

serializedName

serializedName: string = "recoveryAvailabilitySet"

type

type: object

name

name: "String" = "String"

recoveryAzureResourceGroupId

recoveryAzureResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryAzureVMName

recoveryAzureVMName: object

serializedName

serializedName: string = "recoveryAzureVMName"

type

type: object

name

name: "String" = "String"

recoveryAzureVMSize

recoveryAzureVMSize: object

serializedName

serializedName: string = "recoveryAzureVMSize"

type

type: object

name

name: "String" = "String"

recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: object

serializedName

serializedName: string = "recoveryBootDiagStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryCloudService

recoveryCloudService: object

serializedName

serializedName: string = "recoveryCloudService"

type

type: object

name

name: "String" = "String"

recoveryFabricLocation

recoveryFabricLocation: object

serializedName

serializedName: string = "recoveryFabricLocation"

type

type: object

name

name: "String" = "String"

recoveryFabricObjectId

recoveryFabricObjectId: object

serializedName

serializedName: string = "recoveryFabricObjectId"

type

type: object

name

name: "String" = "String"

rpoInSeconds

rpoInSeconds: object

serializedName

serializedName: string = "rpoInSeconds"

type

type: object

name

name: "Number" = "Number"

selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: object

serializedName

serializedName: string = "selectedRecoveryAzureNetworkId"

type

type: object

name

name: "String" = "String"

testFailoverRecoveryFabricObjectId

testFailoverRecoveryFabricObjectId: object

serializedName

serializedName: string = "testFailoverRecoveryFabricObjectId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

vmSyncedConfigDetails

vmSyncedConfigDetails: object

serializedName

serializedName: string = "vmSyncedConfigDetails"

type

type: object

className

className: string = "AzureToAzureVmSyncedConfigDetails"

name

name: "Composite" = "Composite"

Const A2AReprotectInput

A2AReprotectInput: object
interface

An interface representing A2AReprotectInput. Azure specific reprotect input.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional policyId

policyId: undefined | string
member

{string} [policyId] The Policy Id.

Optional recoveryAvailabilitySetId

recoveryAvailabilitySetId: undefined | string
member

{string} [recoveryAvailabilitySetId] The recovery availability set.

Optional recoveryCloudServiceId

recoveryCloudServiceId: undefined | string
member

{string} [recoveryCloudServiceId] The recovery cloud service Id. Valid for V1 scenarios.

Optional recoveryContainerId

recoveryContainerId: undefined | string
member

{string} [recoveryContainerId] The recovery container Id.

Optional recoveryResourceGroupId

recoveryResourceGroupId: undefined | string
member

{string} [recoveryResourceGroupId] The recovery resource group Id. Valid for V2 scenarios.

Optional vmDisks

member

{A2AVmDiskInputDetails[]} [vmDisks] The list of vm disk details.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AReprotectInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReverseReplicationProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReverseReplicationProviderSpecificInput"

modelProperties

modelProperties: object

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

recoveryAvailabilitySetId

recoveryAvailabilitySetId: object

serializedName

serializedName: string = "recoveryAvailabilitySetId"

type

type: object

name

name: "String" = "String"

recoveryCloudServiceId

recoveryCloudServiceId: object

serializedName

serializedName: string = "recoveryCloudServiceId"

type

type: object

name

name: "String" = "String"

recoveryContainerId

recoveryContainerId: object

serializedName

serializedName: string = "recoveryContainerId"

type

type: object

name

name: "String" = "String"

recoveryResourceGroupId

recoveryResourceGroupId: object

serializedName

serializedName: string = "recoveryResourceGroupId"

type

type: object

name

name: "String" = "String"

vmDisks

vmDisks: object

serializedName

serializedName: string = "vmDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AVmDiskInputDetails"

name

name: "Composite" = "Composite"

Const A2ASwitchProtectionInput

A2ASwitchProtectionInput: object
interface

An interface representing A2ASwitchProtectionInput. A2A specific switch protection input.

Optional diskEncryptionInfo

diskEncryptionInfo: DiskEncryptionInfo
member

{DiskEncryptionInfo} [diskEncryptionInfo] The recovery disk encryption information.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional policyId

policyId: undefined | string
member

{string} [policyId] The Policy Id.

Optional recoveryAvailabilitySetId

recoveryAvailabilitySetId: undefined | string
member

{string} [recoveryAvailabilitySetId] The recovery availability set.

Optional recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: undefined | string
member

{string} [recoveryBootDiagStorageAccountId] The boot diagnostic storage account.

Optional recoveryCloudServiceId

recoveryCloudServiceId: undefined | string
member

{string} [recoveryCloudServiceId] The recovery cloud service Id. Valid for V1 scenarios.

Optional recoveryContainerId

recoveryContainerId: undefined | string
member

{string} [recoveryContainerId] The recovery container Id.

Optional recoveryResourceGroupId

recoveryResourceGroupId: undefined | string
member

{string} [recoveryResourceGroupId] The recovery resource group Id. Valid for V2 scenarios.

Optional vmDisks

member

{A2AVmDiskInputDetails[]} [vmDisks] The list of vm disk details.

Optional vmManagedDisks

member

{A2AVmManagedDiskInputDetails[]} [vmManagedDisks] The list of vm managed disk details.

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2ASwitchProtectionInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SwitchProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "SwitchProtectionProviderSpecificInput"

modelProperties

modelProperties: object

diskEncryptionInfo

diskEncryptionInfo: object

serializedName

serializedName: string = "diskEncryptionInfo"

type

type: object

className

className: string = "DiskEncryptionInfo"

name

name: "Composite" = "Composite"

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

recoveryAvailabilitySetId

recoveryAvailabilitySetId: object

serializedName

serializedName: string = "recoveryAvailabilitySetId"

type

type: object

name

name: "String" = "String"

recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: object

serializedName

serializedName: string = "recoveryBootDiagStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryCloudServiceId

recoveryCloudServiceId: object

serializedName

serializedName: string = "recoveryCloudServiceId"

type

type: object

name

name: "String" = "String"

recoveryContainerId

recoveryContainerId: object

serializedName

serializedName: string = "recoveryContainerId"

type

type: object

name

name: "String" = "String"

recoveryResourceGroupId

recoveryResourceGroupId: object

serializedName

serializedName: string = "recoveryResourceGroupId"

type

type: object

name

name: "String" = "String"

vmDisks

vmDisks: object

serializedName

serializedName: string = "vmDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AVmDiskInputDetails"

name

name: "Composite" = "Composite"

vmManagedDisks

vmManagedDisks: object

serializedName

serializedName: string = "vmManagedDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AVmManagedDiskInputDetails"

name

name: "Composite" = "Composite"

Const A2AUpdateContainerMappingInput

A2AUpdateContainerMappingInput: object
interface

An interface representing A2AUpdateContainerMappingInput. A2A update protection container mapping.

Optional agentAutoUpdateStatus

agentAutoUpdateStatus: AgentAutoUpdateStatus
member

{AgentAutoUpdateStatus} [agentAutoUpdateStatus] A value indicating whether the auto update is enabled. Possible values include: 'Disabled', 'Enabled'

Optional automationAccountArmId

automationAccountArmId: undefined | string
member

{string} [automationAccountArmId] The automation account arm id.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AUpdateContainerMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificUpdateContainerMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificUpdateContainerMappingInput"

modelProperties

modelProperties: object

agentAutoUpdateStatus

agentAutoUpdateStatus: object

serializedName

serializedName: string = "agentAutoUpdateStatus"

type

type: object

name

name: "String" = "String"

automationAccountArmId

automationAccountArmId: object

serializedName

serializedName: string = "automationAccountArmId"

type

type: object

name

name: "String" = "String"

Const A2AUpdateReplicationProtectedItemInput

A2AUpdateReplicationProtectedItemInput: object
interface

An interface representing A2AUpdateReplicationProtectedItemInput. InMage Azure V2 input to update replication protected item.

Optional diskEncryptionInfo

diskEncryptionInfo: DiskEncryptionInfo
member

{DiskEncryptionInfo} [diskEncryptionInfo] The recovery os disk encryption information.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional managedDiskUpdateDetails

managedDiskUpdateDetails: A2AVmManagedDiskUpdateDetails[]
member

{A2AVmManagedDiskUpdateDetails[]} [managedDiskUpdateDetails] Managed disk update details.

Optional recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: undefined | string
member

{string} [recoveryBootDiagStorageAccountId] The boot diagnostic storage account.

Optional recoveryCloudServiceId

recoveryCloudServiceId: undefined | string
member

{string} [recoveryCloudServiceId] The target cloud service ARM Id (for V1).

Optional recoveryResourceGroupId

recoveryResourceGroupId: undefined | string
member

{string} [recoveryResourceGroupId] The target resource group ARM Id (for V2).

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "A2AUpdateReplicationProtectedItemInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = UpdateReplicationProtectedItemProviderInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "UpdateReplicationProtectedItemProviderInput"

modelProperties

modelProperties: object

diskEncryptionInfo

diskEncryptionInfo: object

serializedName

serializedName: string = "diskEncryptionInfo"

type

type: object

className

className: string = "DiskEncryptionInfo"

name

name: "Composite" = "Composite"

managedDiskUpdateDetails

managedDiskUpdateDetails: object

serializedName

serializedName: string = "managedDiskUpdateDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "A2AVmManagedDiskUpdateDetails"

name

name: "Composite" = "Composite"

recoveryBootDiagStorageAccountId

recoveryBootDiagStorageAccountId: object

serializedName

serializedName: string = "recoveryBootDiagStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryCloudServiceId

recoveryCloudServiceId: object

serializedName

serializedName: string = "recoveryCloudServiceId"

type

type: object

name

name: "String" = "String"

recoveryResourceGroupId

recoveryResourceGroupId: object

serializedName

serializedName: string = "recoveryResourceGroupId"

type

type: object

name

name: "String" = "String"

Const A2AVmDiskInputDetails

A2AVmDiskInputDetails: object
interface

An interface representing A2AVmDiskInputDetails. Azure VM disk input details.

Optional diskUri

diskUri: undefined | string
member

{string} [diskUri] The disk Uri.

Optional primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: undefined | string
member

{string} [primaryStagingAzureStorageAccountId] The primary staging storage account Id.

Optional recoveryAzureStorageAccountId

recoveryAzureStorageAccountId: undefined | string
member

{string} [recoveryAzureStorageAccountId] The recovery VHD storage account Id.

serializedName

serializedName: string = "A2AVmDiskInputDetails"

type

type: object

className

className: string = "A2AVmDiskInputDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskUri

diskUri: object

serializedName

serializedName: string = "diskUri"

type

type: object

name

name: "String" = "String"

primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: object

serializedName

serializedName: string = "primaryStagingAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryAzureStorageAccountId

recoveryAzureStorageAccountId: object

serializedName

serializedName: string = "recoveryAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

Const A2AVmManagedDiskInputDetails

A2AVmManagedDiskInputDetails: object
interface

An interface representing A2AVmManagedDiskInputDetails. Azure VM managed disk input details.

Optional diskId

diskId: undefined | string
member

{string} [diskId] The disk Id.

Optional primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: undefined | string
member

{string} [primaryStagingAzureStorageAccountId] The primary staging storage account Arm Id.

Optional recoveryReplicaDiskAccountType

recoveryReplicaDiskAccountType: undefined | string
member

{string} [recoveryReplicaDiskAccountType] The replica disk type. Its an optional value and will be same as source disk type if not user provided.

Optional recoveryResourceGroupId

recoveryResourceGroupId: undefined | string
member

{string} [recoveryResourceGroupId] The target resource group Arm Id.

Optional recoveryTargetDiskAccountType

recoveryTargetDiskAccountType: undefined | string
member

{string} [recoveryTargetDiskAccountType] The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.

serializedName

serializedName: string = "A2AVmManagedDiskInputDetails"

type

type: object

className

className: string = "A2AVmManagedDiskInputDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskId

diskId: object

serializedName

serializedName: string = "diskId"

type

type: object

name

name: "String" = "String"

primaryStagingAzureStorageAccountId

primaryStagingAzureStorageAccountId: object

serializedName

serializedName: string = "primaryStagingAzureStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryReplicaDiskAccountType

recoveryReplicaDiskAccountType: object

serializedName

serializedName: string = "recoveryReplicaDiskAccountType"

type

type: object

name

name: "String" = "String"

recoveryResourceGroupId

recoveryResourceGroupId: object

serializedName

serializedName: string = "recoveryResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryTargetDiskAccountType

recoveryTargetDiskAccountType: object

serializedName

serializedName: string = "recoveryTargetDiskAccountType"

type

type: object

name

name: "String" = "String"

Const A2AVmManagedDiskUpdateDetails

A2AVmManagedDiskUpdateDetails: object
interface

An interface representing A2AVmManagedDiskUpdateDetails. Azure VM managed disk update input details.

Optional diskId

diskId: undefined | string
member

{string} [diskId] The disk Id.

Optional recoveryReplicaDiskAccountType

recoveryReplicaDiskAccountType: undefined | string
member

{string} [recoveryReplicaDiskAccountType] The replica disk type before failover.

Optional recoveryTargetDiskAccountType

recoveryTargetDiskAccountType: undefined | string
member

{string} [recoveryTargetDiskAccountType] The target disk type before failover.

serializedName

serializedName: string = "A2AVmManagedDiskUpdateDetails"

type

type: object

className

className: string = "A2AVmManagedDiskUpdateDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskId

diskId: object

serializedName

serializedName: string = "diskId"

type

type: object

name

name: "String" = "String"

recoveryReplicaDiskAccountType

recoveryReplicaDiskAccountType: object

serializedName

serializedName: string = "recoveryReplicaDiskAccountType"

type

type: object

name

name: "String" = "String"

recoveryTargetDiskAccountType

recoveryTargetDiskAccountType: object

serializedName

serializedName: string = "recoveryTargetDiskAccountType"

type

type: object

name

name: "String" = "String"

Const ASRTask

ASRTask: object
interface

An interface representing ASRTask. Task of the Job.

Optional allowedActions

allowedActions: string[]
member

{string[]} [allowedActions] The state/actions applicable on this task.

Optional customDetails

customDetails: TaskTypeDetailsUnion
member

{TaskTypeDetailsUnion} [customDetails] The custom task details based on the task type.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional errors

errors: JobErrorDetails[]
member

{JobErrorDetails[]} [errors] The task error details.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The name.

Optional groupTaskCustomDetails

groupTaskCustomDetails: GroupTaskDetailsUnion
member

{GroupTaskDetailsUnion} [groupTaskCustomDetails] The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it.

Optional name

name: undefined | string
member

{string} [name] The unique Task name.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional state

state: undefined | string
member

{string} [state] The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.

Optional stateDescription

stateDescription: undefined | string
member

{string} [stateDescription] The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The Id.

Optional taskType

taskType: undefined | string
member

{string} [taskType] The type of task. Details in CustomDetails property depend on this type.

serializedName

serializedName: string = "ASRTask"

type

type: object

className

className: string = "ASRTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedActions

allowedActions: object

serializedName

serializedName: string = "allowedActions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

customDetails

customDetails: object

serializedName

serializedName: string = "customDetails"

type

type: object

className

className: string = "TaskTypeDetails"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobErrorDetails"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

groupTaskCustomDetails

groupTaskCustomDetails: object

serializedName

serializedName: string = "groupTaskCustomDetails"

type

type: object

className

className: string = "GroupTaskDetails"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

stateDescription

stateDescription: object

serializedName

serializedName: string = "stateDescription"

type

type: object

name

name: "String" = "String"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

taskType

taskType: object

serializedName

serializedName: string = "taskType"

type

type: object

name

name: "String" = "String"

Const AddVCenterRequest

AddVCenterRequest: object
interface

An interface representing AddVCenterRequest. Input required to add vCenter.

Optional properties

member

{AddVCenterRequestProperties} [properties] The properties of an add vCenter request.

serializedName

serializedName: string = "AddVCenterRequest"

type

type: object

className

className: string = "AddVCenterRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "AddVCenterRequestProperties"

name

name: "Composite" = "Composite"

Const AddVCenterRequestProperties

AddVCenterRequestProperties: object
interface

An interface representing AddVCenterRequestProperties. The properties of an add vCenter request.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The friendly name of the vCenter.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of the vCenter to be discovered.

Optional port

port: undefined | string
member

{string} [port] The port number for discovery.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The process server Id from where the discovery is orchestrated.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The account Id which has privileges to discover the vCenter.

serializedName

serializedName: string = "AddVCenterRequestProperties"

type

type: object

className

className: string = "AddVCenterRequestProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

Const Alert

Alert: object
interface

An interface representing Alert. Implements the Alert class.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: AlertProperties
member

{AlertProperties} [properties] Alert related data.

serializedName

serializedName: string = "Alert"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Alert"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "AlertProperties"

name

name: "Composite" = "Composite"

Const AlertCollection

AlertCollection: object
interface

An interface representing the AlertCollection. Collection of alerts.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "AlertCollection"

__@iterator

  • __@iterator(): IterableIterator<Alert>
  • Iterator

    Returns IterableIterator<Alert>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Alert>[]): Alert[]
  • concat(...items: (T | ConcatArray<T>)[]): Alert[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Alert>[]

      Additional items to add to the end of array1.

    Returns Alert[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Alert[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Alert]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Alert]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Alert, index: number, array: Alert[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Alert, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Alert

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Alert[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): any
        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Alert[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Alert | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Alert, index: number, obj: Alert[]): boolean
        • Parameters

          • this: void
          • value: Alert
          • index: number
          • obj: Alert[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Alert, index: number, obj: Alert[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Alert | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Alert, index: number, obj: Alert[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): void
        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Alert, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Alert

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Alert, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Alert

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Alert, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Alert

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): U
        • Parameters

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Alert | undefined
  • Removes the last element from an array and returns it.

    Returns Alert | undefined

push

  • push(...items: Alert[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Alert[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Alert
  • reduce(callbackfn: function, initialValue: Alert): Alert
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Alert

  • Parameters

    • callbackfn: function
    • initialValue: Alert

    Returns Alert

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Alert, currentIndex: number, array: Alert[]): U
        • Parameters

          • previousValue: U
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Alert
  • reduceRight(callbackfn: function, initialValue: Alert): Alert
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Alert

  • Parameters

    • callbackfn: function
    • initialValue: Alert

    Returns Alert

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Alert, currentIndex: number, array: Alert[]): U
        • Parameters

          • previousValue: U
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Alert[]

shift

  • shift(): Alert | undefined
  • Removes the first element from an array and returns it.

    Returns Alert | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Alert[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Alert[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Alert, index: number, array: Alert[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Alert[]
  • splice(start: number, deleteCount: number, ...items: Alert[]): Alert[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Alert[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Alert[]

      Elements to insert into the array in place of the deleted elements.

    Returns Alert[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Alert[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Alert[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Alert>
  • Returns an iterable of values in the array

    Returns IterableIterator<Alert>

type

type: object

className

className: string = "AlertCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Alert"

name

name: "Composite" = "Composite"

Const AlertProperties

AlertProperties: object
interface

An interface representing AlertProperties. The proprties of an alert.

Optional customEmailAddresses

customEmailAddresses: string[]
member

{string[]} [customEmailAddresses] The custom email address for sending emails.

Optional locale

locale: undefined | string
member

{string} [locale] The locale for the email notification.

Optional sendToOwners

sendToOwners: undefined | string
member

{string} [sendToOwners] A value indicating whether to send email to subscription administrator.

serializedName

serializedName: string = "AlertProperties"

type

type: object

className

className: string = "AlertProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customEmailAddresses

customEmailAddresses: object

serializedName

serializedName: string = "customEmailAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

locale

locale: object

serializedName

serializedName: string = "locale"

type

type: object

name

name: "String" = "String"

sendToOwners

sendToOwners: object

serializedName

serializedName: string = "sendToOwners"

type

type: object

name

name: "String" = "String"

Const ApplyRecoveryPointInput

ApplyRecoveryPointInput: object
interface

An interface representing ApplyRecoveryPointInput. Input to apply recovery point.

Optional properties

member

{ApplyRecoveryPointInputProperties} [properties] The input properties to apply recovery point.

serializedName

serializedName: string = "ApplyRecoveryPointInput"

type

type: object

className

className: string = "ApplyRecoveryPointInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ApplyRecoveryPointInputProperties"

name

name: "Composite" = "Composite"

Const ApplyRecoveryPointInputProperties

ApplyRecoveryPointInputProperties: object
interface

An interface representing ApplyRecoveryPointInputProperties. Input properties to apply recovery point.

Optional providerSpecificDetails

member

{ApplyRecoveryPointProviderSpecificInputUnion} [providerSpecificDetails] Provider specific input for applying recovery point.

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] The recovery point Id.

serializedName

serializedName: string = "ApplyRecoveryPointInputProperties"

type

type: object

className

className: string = "ApplyRecoveryPointInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ApplyRecoveryPointProviderSpecificInput"

name

name: "Composite" = "Composite"

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

Const ApplyRecoveryPointProviderSpecificInput

ApplyRecoveryPointProviderSpecificInput: object
interface

An interface representing ApplyRecoveryPointProviderSpecificInput. Provider specific input for apply recovery point.

instanceType

instanceType: "ApplyRecoveryPointProviderSpecificInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ApplyRecoveryPointProviderSpecificInput"

type

type: object

className

className: string = "ApplyRecoveryPointProviderSpecificInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ApplyRecoveryPointProviderSpecificInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const AsrJobDetails

AsrJobDetails: object
interface

An interface representing AsrJobDetails. This class represents job details based on specific job type.

Optional affectedObjectDetails

affectedObjectDetails: undefined | object
member

{{ [propertyName: string]: string }} [affectedObjectDetails] The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.

instanceType

instanceType: "AsrJobDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "AsrJobDetails"

type

type: object

className

className: string = "AsrJobDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobDetails"

modelProperties

modelProperties: object

Const AutomationRunbookTaskDetails

AutomationRunbookTaskDetails: object
interface

An interface representing AutomationRunbookTaskDetails. This class represents the task details for an automation runbook.

Optional accountName

accountName: undefined | string
member

{string} [accountName] The automation account name of the runbook.

Optional cloudServiceName

cloudServiceName: undefined | string
member

{string} [cloudServiceName] The cloud service of the automation runbook account.

instanceType

instanceType: "AutomationRunbookTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional isPrimarySideScript

isPrimarySideScript: undefined | false | true
member

{boolean} [isPrimarySideScript] A value indicating whether it is a primary side script or not.

Optional jobId

jobId: undefined | string
member

{string} [jobId] The job Id of the runbook execution.

Optional jobOutput

jobOutput: undefined | string
member

{string} [jobOutput] The execution output of the runbook.

Optional name

name: undefined | string
member

{string} [name] The recovery plan task name.

Optional runbookId

runbookId: undefined | string
member

{string} [runbookId] The runbook Id.

Optional runbookName

runbookName: undefined | string
member

{string} [runbookName] The runbook name.

Optional subscriptionId

subscriptionId: undefined | string
member

{string} [subscriptionId] The subscription Id of the automation runbook account.

serializedName

serializedName: string = "AutomationRunbookTaskDetails"

type

type: object

className

className: string = "AutomationRunbookTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

accountName

accountName: object

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

cloudServiceName

cloudServiceName: object

serializedName

serializedName: string = "cloudServiceName"

type

type: object

name

name: "String" = "String"

isPrimarySideScript

isPrimarySideScript: object

serializedName

serializedName: string = "isPrimarySideScript"

type

type: object

name

name: "Boolean" = "Boolean"

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

jobOutput

jobOutput: object

serializedName

serializedName: string = "jobOutput"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

runbookId

runbookId: object

serializedName

serializedName: string = "runbookId"

type

type: object

name

name: "String" = "String"

runbookName

runbookName: object

serializedName

serializedName: string = "runbookName"

type

type: object

name

name: "String" = "String"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const AzureFabricCreationInput

AzureFabricCreationInput: object
interface

An interface representing AzureFabricCreationInput. Fabric provider specific settings.

instanceType

instanceType: "Azure"
member

{string} instanceType Polymorphic Discriminator

Optional location

location: undefined | string
member

{string} [location] The Location.

serializedName

serializedName: string = "Azure"

type

type: object

className

className: string = "AzureFabricCreationInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificCreationInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificCreationInput"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const AzureFabricSpecificDetails

AzureFabricSpecificDetails: object
interface

An interface representing AzureFabricSpecificDetails. Azure Fabric Specific Details.

Optional containerIds

containerIds: string[]
member

{string[]} [containerIds] The container Ids for the Azure fabric.

instanceType

instanceType: "Azure"
member

{string} instanceType Polymorphic Discriminator

Optional location

location: undefined | string
member

{string} [location] The Location for the Azure fabric.

serializedName

serializedName: string = "Azure"

type

type: object

className

className: string = "AzureFabricSpecificDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificDetails"

modelProperties

modelProperties: object

containerIds

containerIds: object

serializedName

serializedName: string = "containerIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const AzureToAzureCreateNetworkMappingInput

AzureToAzureCreateNetworkMappingInput: object
interface

An interface representing AzureToAzureCreateNetworkMappingInput. Create network mappings input properties/behaviour specific to Azure to Azure Network mapping.

instanceType

instanceType: "AzureToAzure"
member

{string} instanceType Polymorphic Discriminator

Optional primaryNetworkId

primaryNetworkId: undefined | string
member

{string} [primaryNetworkId] The primary azure vnet Id.

serializedName

serializedName: string = "AzureToAzure"

type

type: object

className

className: string = "AzureToAzureCreateNetworkMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificCreateNetworkMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificCreateNetworkMappingInput"

modelProperties

modelProperties: object

primaryNetworkId

primaryNetworkId: object

serializedName

serializedName: string = "primaryNetworkId"

type

type: object

name

name: "String" = "String"

Const AzureToAzureNetworkMappingSettings

AzureToAzureNetworkMappingSettings: object
interface

An interface representing AzureToAzureNetworkMappingSettings. A2A Network Mapping fabric specific settings.

instanceType

instanceType: "AzureToAzure"
member

{string} instanceType Polymorphic Discriminator

Optional primaryFabricLocation

primaryFabricLocation: undefined | string
member

{string} [primaryFabricLocation] The primary fabric location.

Optional recoveryFabricLocation

recoveryFabricLocation: undefined | string
member

{string} [recoveryFabricLocation] The recovery fabric location.

serializedName

serializedName: string = "AzureToAzure"

type

type: object

className

className: string = "AzureToAzureNetworkMappingSettings"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = NetworkMappingFabricSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "NetworkMappingFabricSpecificSettings"

modelProperties

modelProperties: object

primaryFabricLocation

primaryFabricLocation: object

serializedName

serializedName: string = "primaryFabricLocation"

type

type: object

name

name: "String" = "String"

recoveryFabricLocation

recoveryFabricLocation: object

serializedName

serializedName: string = "recoveryFabricLocation"

type

type: object

name

name: "String" = "String"

Const AzureToAzureUpdateNetworkMappingInput

AzureToAzureUpdateNetworkMappingInput: object
interface

An interface representing AzureToAzureUpdateNetworkMappingInput. Updates network mappings input.

instanceType

instanceType: "AzureToAzure"
member

{string} instanceType Polymorphic Discriminator

Optional primaryNetworkId

primaryNetworkId: undefined | string
member

{string} [primaryNetworkId] The primary azure vnet Id.

serializedName

serializedName: string = "AzureToAzure"

type

type: object

className

className: string = "AzureToAzureUpdateNetworkMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificUpdateNetworkMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificUpdateNetworkMappingInput"

modelProperties

modelProperties: object

primaryNetworkId

primaryNetworkId: object

serializedName

serializedName: string = "primaryNetworkId"

type

type: object

name

name: "String" = "String"

Const AzureToAzureVmSyncedConfigDetails

AzureToAzureVmSyncedConfigDetails: object
interface

An interface representing AzureToAzureVmSyncedConfigDetails. Azure to Azure VM synced configuration details.

Optional inputEndpoints

inputEndpoints: InputEndpoint[]
member

{InputEndpoint[]} [inputEndpoints] The Azure VM input endpoints.

Optional roleAssignments

roleAssignments: RoleAssignment[]
member

{RoleAssignment[]} [roleAssignments] The Azure role assignments.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The Azure VM tags.

serializedName

serializedName: string = "AzureToAzureVmSyncedConfigDetails"

type

type: object

className

className: string = "AzureToAzureVmSyncedConfigDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inputEndpoints

inputEndpoints: object

serializedName

serializedName: string = "inputEndpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InputEndpoint"

name

name: "Composite" = "Composite"

roleAssignments

roleAssignments: object

serializedName

serializedName: string = "roleAssignments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RoleAssignment"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const AzureVmDiskDetails

AzureVmDiskDetails: object
interface

An interface representing AzureVmDiskDetails. Disk details for E2A provider.

Optional lunId

lunId: undefined | string
member

{string} [lunId] Ordinal\LunId of the disk for the Azure VM.

Optional maxSizeMB

maxSizeMB: undefined | string
member

{string} [maxSizeMB] Max side in MB.

Optional targetDiskLocation

targetDiskLocation: undefined | string
member

{string} [targetDiskLocation] Blob uri of the Azure disk.

Optional targetDiskName

targetDiskName: undefined | string
member

{string} [targetDiskName] The target Azure disk name.

Optional vhdId

vhdId: undefined | string
member

{string} [vhdId] The VHD id.

Optional vhdName

vhdName: undefined | string
member

{string} [vhdName] VHD name.

Optional vhdType

vhdType: undefined | string
member

{string} [vhdType] VHD type.

serializedName

serializedName: string = "AzureVmDiskDetails"

type

type: object

className

className: string = "AzureVmDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lunId

lunId: object

serializedName

serializedName: string = "lunId"

type

type: object

name

name: "String" = "String"

maxSizeMB

maxSizeMB: object

serializedName

serializedName: string = "maxSizeMB"

type

type: object

name

name: "String" = "String"

targetDiskLocation

targetDiskLocation: object

serializedName

serializedName: string = "targetDiskLocation"

type

type: object

name

name: "String" = "String"

targetDiskName

targetDiskName: object

serializedName

serializedName: string = "targetDiskName"

type

type: object

name

name: "String" = "String"

vhdId

vhdId: object

serializedName

serializedName: string = "vhdId"

type

type: object

name

name: "String" = "String"

vhdName

vhdName: object

serializedName

serializedName: string = "vhdName"

type

type: object

name

name: "String" = "String"

vhdType

vhdType: object

serializedName

serializedName: string = "vhdType"

type

type: object

name

name: "String" = "String"

Const ComputeSizeErrorDetails

ComputeSizeErrorDetails: object
interface

An interface representing ComputeSizeErrorDetails. Represents the error used to indicate why the target compute size is not applicable.

Optional message

message: undefined | string
member

{string} [message] The error message.

Optional severity

severity: undefined | string
member

{string} [severity] The severity of the error.

serializedName

serializedName: string = "ComputeSizeErrorDetails"

type

type: object

className

className: string = "ComputeSizeErrorDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

name

name: "String" = "String"

Const ConfigurationSettings

ConfigurationSettings: object
interface

An interface representing ConfigurationSettings. Replication provider specific settings.

instanceType

instanceType: "ConfigurationSettings"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ConfigurationSettings"

type

type: object

className

className: string = "ConfigurationSettings"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ConfigurationSettings"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ConfigureAlertRequest

ConfigureAlertRequest: object
interface

An interface representing ConfigureAlertRequest. Request to configure alerts for the system.

Optional properties

member

{ConfigureAlertRequestProperties} [properties] The properties of a configure alert request.

serializedName

serializedName: string = "ConfigureAlertRequest"

type

type: object

className

className: string = "ConfigureAlertRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ConfigureAlertRequestProperties"

name

name: "Composite" = "Composite"

Const ConfigureAlertRequestProperties

ConfigureAlertRequestProperties: object
interface

An interface representing ConfigureAlertRequestProperties. Properties of a configure alert request.

Optional customEmailAddresses

customEmailAddresses: string[]
member

{string[]} [customEmailAddresses] The custom email address for sending emails.

Optional locale

locale: undefined | string
member

{string} [locale] The locale for the email notification.

Optional sendToOwners

sendToOwners: undefined | string
member

{string} [sendToOwners] A value indicating whether to send email to subscription administrator.

serializedName

serializedName: string = "ConfigureAlertRequestProperties"

type

type: object

className

className: string = "ConfigureAlertRequestProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customEmailAddresses

customEmailAddresses: object

serializedName

serializedName: string = "customEmailAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

locale

locale: object

serializedName

serializedName: string = "locale"

type

type: object

name

name: "String" = "String"

sendToOwners

sendToOwners: object

serializedName

serializedName: string = "sendToOwners"

type

type: object

name

name: "String" = "String"

Const ConsistencyCheckTaskDetails

ConsistencyCheckTaskDetails: object
interface

An interface representing ConsistencyCheckTaskDetails. This class contains monitoring details of all the inconsistent Protected Entites in Vmm.

instanceType

instanceType: "ConsistencyCheckTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional vmDetails

member

{InconsistentVmDetails[]} [vmDetails] The list of inconsistent Vm details.

serializedName

serializedName: string = "ConsistencyCheckTaskDetails"

type

type: object

className

className: string = "ConsistencyCheckTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

vmDetails

vmDetails: object

serializedName

serializedName: string = "vmDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InconsistentVmDetails"

name

name: "Composite" = "Composite"

Const CreateNetworkMappingInput

CreateNetworkMappingInput: object
interface

An interface representing CreateNetworkMappingInput. Create network mappings input.

Optional properties

member

{CreateNetworkMappingInputProperties} [properties] Input properties for creating network mapping.

serializedName

serializedName: string = "CreateNetworkMappingInput"

type

type: object

className

className: string = "CreateNetworkMappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CreateNetworkMappingInputProperties"

name

name: "Composite" = "Composite"

Const CreateNetworkMappingInputProperties

CreateNetworkMappingInputProperties: object
interface

An interface representing CreateNetworkMappingInputProperties. Common input details for network mapping operation.

Optional fabricSpecificDetails

member

{FabricSpecificCreateNetworkMappingInputUnion} [fabricSpecificDetails] Fabric specific input properties.

Optional recoveryFabricName

recoveryFabricName: undefined | string
member

{string} [recoveryFabricName] Recovery fabric Name.

Optional recoveryNetworkId

recoveryNetworkId: undefined | string
member

{string} [recoveryNetworkId] Recovery network Id.

serializedName

serializedName: string = "CreateNetworkMappingInputProperties"

type

type: object

className

className: string = "CreateNetworkMappingInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fabricSpecificDetails

fabricSpecificDetails: object

serializedName

serializedName: string = "fabricSpecificDetails"

type

type: object

className

className: string = "FabricSpecificCreateNetworkMappingInput"

name

name: "Composite" = "Composite"

recoveryFabricName

recoveryFabricName: object

serializedName

serializedName: string = "recoveryFabricName"

type

type: object

name

name: "String" = "String"

recoveryNetworkId

recoveryNetworkId: object

serializedName

serializedName: string = "recoveryNetworkId"

type

type: object

name

name: "String" = "String"

Const CreatePolicyInput

CreatePolicyInput: object
interface

An interface representing CreatePolicyInput. Protection Policy input.

Optional properties

member

{CreatePolicyInputProperties} [properties] Policy creation properties.

serializedName

serializedName: string = "CreatePolicyInput"

type

type: object

className

className: string = "CreatePolicyInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CreatePolicyInputProperties"

name

name: "Composite" = "Composite"

Const CreatePolicyInputProperties

CreatePolicyInputProperties: object
interface

An interface representing CreatePolicyInputProperties. Policy creation properties.

Optional providerSpecificInput

providerSpecificInput: PolicyProviderSpecificInputUnion
member

{PolicyProviderSpecificInputUnion} [providerSpecificInput] The ReplicationProviderSettings.

serializedName

serializedName: string = "CreatePolicyInputProperties"

type

type: object

className

className: string = "CreatePolicyInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificInput

providerSpecificInput: object

serializedName

serializedName: string = "providerSpecificInput"

type

type: object

className

className: string = "PolicyProviderSpecificInput"

name

name: "Composite" = "Composite"

Const CreateProtectionContainerInput

CreateProtectionContainerInput: object
interface

An interface representing CreateProtectionContainerInput. Create protection container input.

Optional properties

member

{CreateProtectionContainerInputProperties} [properties] Create protection container input properties.

serializedName

serializedName: string = "CreateProtectionContainerInput"

type

type: object

className

className: string = "CreateProtectionContainerInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CreateProtectionContainerInputProperties"

name

name: "Composite" = "Composite"

Const CreateProtectionContainerInputProperties

CreateProtectionContainerInputProperties: object
interface

An interface representing CreateProtectionContainerInputProperties. Create protection container input properties.

Optional providerSpecificInput

member

{ReplicationProviderSpecificContainerCreationInputUnion[]} [providerSpecificInput] Provider specific inputs for container creation.

serializedName

serializedName: string = "CreateProtectionContainerInputProperties"

type

type: object

className

className: string = "CreateProtectionContainerInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificInput

providerSpecificInput: object

serializedName

serializedName: string = "providerSpecificInput"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicationProviderSpecificContainerCreationInput"

name

name: "Composite" = "Composite"

Const CreateProtectionContainerMappingInput

CreateProtectionContainerMappingInput: object
interface

An interface representing CreateProtectionContainerMappingInput. Configure pairing input.

Optional properties

member

{CreateProtectionContainerMappingInputProperties} [properties] Configure protection input properties.

serializedName

serializedName: string = "CreateProtectionContainerMappingInput"

type

type: object

className

className: string = "CreateProtectionContainerMappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CreateProtectionContainerMappingInputProperties"

name

name: "Composite" = "Composite"

Const CreateProtectionContainerMappingInputProperties

CreateProtectionContainerMappingInputProperties: object
interface

An interface representing CreateProtectionContainerMappingInputProperties. Configure pairing input properties.

Optional policyId

policyId: undefined | string
member

{string} [policyId] Applicable policy.

Optional providerSpecificInput

member

{ReplicationProviderSpecificContainerMappingInputUnion} [providerSpecificInput] Provider specific input for pairing.

Optional targetProtectionContainerId

targetProtectionContainerId: undefined | string
member

{string} [targetProtectionContainerId] The target unique protection container name.

serializedName

serializedName: string = "CreateProtectionContainerMappingInputProperties"

type

type: object

className

className: string = "CreateProtectionContainerMappingInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

providerSpecificInput

providerSpecificInput: object

serializedName

serializedName: string = "providerSpecificInput"

type

type: object

className

className: string = "ReplicationProviderSpecificContainerMappingInput"

name

name: "Composite" = "Composite"

targetProtectionContainerId

targetProtectionContainerId: object

serializedName

serializedName: string = "targetProtectionContainerId"

type

type: object

name

name: "String" = "String"

Const CreateRecoveryPlanInput

CreateRecoveryPlanInput: object
interface

An interface representing CreateRecoveryPlanInput. Create recovery plan input class.

properties

member

{CreateRecoveryPlanInputProperties} properties Recovery plan creation properties.

serializedName

serializedName: string = "CreateRecoveryPlanInput"

type

type: object

className

className: string = "CreateRecoveryPlanInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CreateRecoveryPlanInputProperties"

name

name: "Composite" = "Composite"

Const CreateRecoveryPlanInputProperties

CreateRecoveryPlanInputProperties: object
interface

An interface representing CreateRecoveryPlanInputProperties. Recovery plan creation properties.

Optional failoverDeploymentModel

failoverDeploymentModel: FailoverDeploymentModel
member

{FailoverDeploymentModel} [failoverDeploymentModel] The failover deployment model. Possible values include: 'NotApplicable', 'Classic', 'ResourceManager'

groups

member

{RecoveryPlanGroup[]} groups The recovery plan groups.

primaryFabricId

primaryFabricId: string
member

{string} primaryFabricId The primary fabric Id.

recoveryFabricId

recoveryFabricId: string
member

{string} recoveryFabricId The recovery fabric Id.

serializedName

serializedName: string = "CreateRecoveryPlanInputProperties"

type

type: object

className

className: string = "CreateRecoveryPlanInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDeploymentModel

failoverDeploymentModel: object

serializedName

serializedName: string = "failoverDeploymentModel"

type

type: object

name

name: "String" = "String"

groups

groups: object

required

required: true = true

serializedName

serializedName: string = "groups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanGroup"

name

name: "Composite" = "Composite"

primaryFabricId

primaryFabricId: object

required

required: true = true

serializedName

serializedName: string = "primaryFabricId"

type

type: object

name

name: "String" = "String"

recoveryFabricId

recoveryFabricId: object

required

required: true = true

serializedName

serializedName: string = "recoveryFabricId"

type

type: object

name

name: "String" = "String"

Const CurrentScenarioDetails

CurrentScenarioDetails: object
interface

An interface representing CurrentScenarioDetails. Current scenario details of the protected entity.

Optional jobId

jobId: undefined | string
member

{string} [jobId] ARM Id of the job being executed.

Optional scenarioName

scenarioName: undefined | string
member

{string} [scenarioName] Scenario name.

Optional startTime

startTime: Date
member

{Date} [startTime] Start time of the workflow.

serializedName

serializedName: string = "CurrentScenarioDetails"

type

type: object

className

className: string = "CurrentScenarioDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

scenarioName

scenarioName: object

serializedName

serializedName: string = "scenarioName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const DataStore

DataStore: object
interface

An interface representing DataStore. The datastore details of the MT.

Optional capacity

capacity: undefined | string
member

{string} [capacity] The capacity of data store in GBs.

Optional freeSpace

freeSpace: undefined | string
member

{string} [freeSpace] The free space of data store in GBs.

Optional symbolicName

symbolicName: undefined | string
member

{string} [symbolicName] The symbolic name of data store.

Optional uuid

uuid: undefined | string
member

{string} [uuid] The uuid of data store.

serializedName

serializedName: string = "DataStore"

Optional type

type: object
member

{string} [type] The type of data store.

className

className: string = "DataStore"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "String" = "String"

freeSpace

freeSpace: object

serializedName

serializedName: string = "freeSpace"

type

type: object

name

name: "String" = "String"

symbolicName

symbolicName: object

serializedName

serializedName: string = "symbolicName"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

uuid

uuid: object

serializedName

serializedName: string = "uuid"

type

type: object

name

name: "String" = "String"

Const DisableProtectionInput

DisableProtectionInput: object
interface

An interface representing DisableProtectionInput. Disable protection input.

Optional properties

member

{DisableProtectionInputProperties} [properties] Disable protection input properties.

serializedName

serializedName: string = "DisableProtectionInput"

type

type: object

className

className: string = "DisableProtectionInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "DisableProtectionInputProperties"

name

name: "Composite" = "Composite"

Const DisableProtectionInputProperties

DisableProtectionInputProperties: object
interface

An interface representing DisableProtectionInputProperties. Disable protection input properties.

Optional disableProtectionReason

disableProtectionReason: DisableProtectionReason
member

{DisableProtectionReason} [disableProtectionReason] Disable protection reason. It can have values NotSpecified/MigrationComplete. Possible values include: 'NotSpecified', 'MigrationComplete'

Optional replicationProviderInput

member

{DisableProtectionProviderSpecificInputUnion} [replicationProviderInput] Replication provider specific input.

serializedName

serializedName: string = "DisableProtectionInputProperties"

type

type: object

className

className: string = "DisableProtectionInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disableProtectionReason

disableProtectionReason: object

serializedName

serializedName: string = "disableProtectionReason"

type

type: object

name

name: "String" = "String"

replicationProviderInput

replicationProviderInput: object

serializedName

serializedName: string = "replicationProviderInput"

type

type: object

className

className: string = "DisableProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

Const DisableProtectionProviderSpecificInput

DisableProtectionProviderSpecificInput: object
interface

An interface representing DisableProtectionProviderSpecificInput. Disable protection provider specific input.

instanceType

instanceType: "DisableProtectionProviderSpecificInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "DisableProtectionProviderSpecificInput"

type

type: object

className

className: string = "DisableProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DisableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const DiscoverProtectableItemRequest

DiscoverProtectableItemRequest: object
interface

An interface representing DiscoverProtectableItemRequest. Request to add a physical machine as a protectable item in a container.

Optional properties

member

{DiscoverProtectableItemRequestProperties} [properties] The properties of a discover protectable item request.

serializedName

serializedName: string = "DiscoverProtectableItemRequest"

type

type: object

className

className: string = "DiscoverProtectableItemRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "DiscoverProtectableItemRequestProperties"

name

name: "Composite" = "Composite"

Const DiscoverProtectableItemRequestProperties

DiscoverProtectableItemRequestProperties: object
interface

An interface representing DiscoverProtectableItemRequestProperties. Discover protectable item properties.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The friendly name of the physical machine.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of the physical machine to be discovered.

Optional osType

osType: undefined | string
member

{string} [osType] The OS type on the physical machine.

serializedName

serializedName: string = "DiscoverProtectableItemRequestProperties"

type

type: object

className

className: string = "DiscoverProtectableItemRequestProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

Const DiskDetails

DiskDetails: object
interface

An interface representing DiskDetails. Onprem disk details data.

Optional maxSizeMB

maxSizeMB: undefined | number
member

{number} [maxSizeMB] The hard disk max size in MB.

Optional vhdId

vhdId: undefined | string
member

{string} [vhdId] The VHD Id.

Optional vhdName

vhdName: undefined | string
member

{string} [vhdName] The VHD name.

Optional vhdType

vhdType: undefined | string
member

{string} [vhdType] The type of the volume.

serializedName

serializedName: string = "DiskDetails"

type

type: object

className

className: string = "DiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxSizeMB

maxSizeMB: object

serializedName

serializedName: string = "maxSizeMB"

type

type: object

name

name: "Number" = "Number"

vhdId

vhdId: object

serializedName

serializedName: string = "vhdId"

type

type: object

name

name: "String" = "String"

vhdName

vhdName: object

serializedName

serializedName: string = "vhdName"

type

type: object

name

name: "String" = "String"

vhdType

vhdType: object

serializedName

serializedName: string = "vhdType"

type

type: object

name

name: "String" = "String"

Const DiskEncryptionInfo

DiskEncryptionInfo: object
interface

An interface representing DiskEncryptionInfo. Recovery disk encryption info (BEK and KEK).

Optional diskEncryptionKeyInfo

diskEncryptionKeyInfo: DiskEncryptionKeyInfo
member

{DiskEncryptionKeyInfo} [diskEncryptionKeyInfo] The recovery KeyVault reference for secret.

Optional keyEncryptionKeyInfo

keyEncryptionKeyInfo: KeyEncryptionKeyInfo
member

{KeyEncryptionKeyInfo} [keyEncryptionKeyInfo] The recovery KeyVault reference for key.

serializedName

serializedName: string = "DiskEncryptionInfo"

type

type: object

className

className: string = "DiskEncryptionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskEncryptionKeyInfo

diskEncryptionKeyInfo: object

serializedName

serializedName: string = "diskEncryptionKeyInfo"

type

type: object

className

className: string = "DiskEncryptionKeyInfo"

name

name: "Composite" = "Composite"

keyEncryptionKeyInfo

keyEncryptionKeyInfo: object

serializedName

serializedName: string = "keyEncryptionKeyInfo"

type

type: object

className

className: string = "KeyEncryptionKeyInfo"

name

name: "Composite" = "Composite"

Const DiskEncryptionKeyInfo

DiskEncryptionKeyInfo: object
interface

An interface representing DiskEncryptionKeyInfo. Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).

Optional keyVaultResourceArmId

keyVaultResourceArmId: undefined | string
member

{string} [keyVaultResourceArmId] The KeyVault resource ARM id for secret.

Optional secretIdentifier

secretIdentifier: undefined | string
member

{string} [secretIdentifier] The secret url / identifier.

serializedName

serializedName: string = "DiskEncryptionKeyInfo"

type

type: object

className

className: string = "DiskEncryptionKeyInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyVaultResourceArmId

keyVaultResourceArmId: object

serializedName

serializedName: string = "keyVaultResourceArmId"

type

type: object

name

name: "String" = "String"

secretIdentifier

secretIdentifier: object

serializedName

serializedName: string = "secretIdentifier"

type

type: object

name

name: "String" = "String"

Const DiskVolumeDetails

DiskVolumeDetails: object
interface

An interface representing DiskVolumeDetails. Volume details.

Optional label

label: undefined | string
member

{string} [label] The volume label.

Optional name

name: undefined | string
member

{string} [name] The volume name.

serializedName

serializedName: string = "DiskVolumeDetails"

type

type: object

className

className: string = "DiskVolumeDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Display

Display: object
interface

An interface representing Display. Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.

Optional description

description: undefined | string
member

{string} [description] The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'

Optional operation

operation: undefined | string
member

{string} [operation] The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'

Optional provider

provider: undefined | string
member

{string} [provider] The provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute."

Optional resource

resource: undefined | string
member

{string} [resource] The resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should not reuse their parent’s display.resource field). e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs"

serializedName

serializedName: string = "Display"

type

type: object

className

className: string = "Display"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const EnableProtectionInput

EnableProtectionInput: object
interface

An interface representing EnableProtectionInput. Enable protection input.

Optional properties

member

{EnableProtectionInputProperties} [properties] Enable protection input properties.

serializedName

serializedName: string = "EnableProtectionInput"

type

type: object

className

className: string = "EnableProtectionInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "EnableProtectionInputProperties"

name

name: "Composite" = "Composite"

Const EnableProtectionInputProperties

EnableProtectionInputProperties: object
interface

An interface representing EnableProtectionInputProperties. Enable protection input properties.

Optional policyId

policyId: undefined | string
member

{string} [policyId] The Policy Id.

Optional protectableItemId

protectableItemId: undefined | string
member

{string} [protectableItemId] The protectable item Id.

Optional providerSpecificDetails

member

{EnableProtectionProviderSpecificInputUnion} [providerSpecificDetails] The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null.

serializedName

serializedName: string = "EnableProtectionInputProperties"

type

type: object

className

className: string = "EnableProtectionInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

protectableItemId

protectableItemId: object

serializedName

serializedName: string = "protectableItemId"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "EnableProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

Const EnableProtectionProviderSpecificInput

EnableProtectionProviderSpecificInput: object
interface

An interface representing EnableProtectionProviderSpecificInput. Enable protection provider specific input.

instanceType

instanceType: "EnableProtectionProviderSpecificInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "EnableProtectionProviderSpecificInput"

type

type: object

className

className: string = "EnableProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "EnableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const EncryptionDetails

EncryptionDetails: object
interface

An interface representing EncryptionDetails. Encryption details for the fabric.

Optional kekCertExpiryDate

kekCertExpiryDate: Date
member

{Date} [kekCertExpiryDate] The key encryption key certificate expiry date.

Optional kekCertThumbprint

kekCertThumbprint: undefined | string
member

{string} [kekCertThumbprint] The key encryption key certificate thumbprint.

Optional kekState

kekState: undefined | string
member

{string} [kekState] The key encryption key state for the Vmm.

serializedName

serializedName: string = "EncryptionDetails"

type

type: object

className

className: string = "EncryptionDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kekCertExpiryDate

kekCertExpiryDate: object

serializedName

serializedName: string = "kekCertExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

kekCertThumbprint

kekCertThumbprint: object

serializedName

serializedName: string = "kekCertThumbprint"

type

type: object

name

name: "String" = "String"

kekState

kekState: object

serializedName

serializedName: string = "kekState"

type

type: object

name

name: "String" = "String"

Const Event

Event: object
interface

An interface representing Event. Implements the Event class.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: EventProperties
member

{EventProperties} [properties] Event related data.

serializedName

serializedName: string = "Event"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Event"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "EventProperties"

name

name: "Composite" = "Composite"

Const EventCollection

EventCollection: object
interface

An interface representing the EventCollection. Collection of fabric details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "EventCollection"

__@iterator

  • __@iterator(): IterableIterator<Event>
  • Iterator

    Returns IterableIterator<Event>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Event>[]): Event[]
  • concat(...items: (T | ConcatArray<T>)[]): Event[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Event>[]

      Additional items to add to the end of array1.

    Returns Event[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Event[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Event]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Event]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Event, index: number, array: Event[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Event, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Event

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Event[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Event, index: number, array: Event[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Event, index: number, array: Event[]): any
        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Event[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Event | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Event, index: number, obj: Event[]): boolean
        • Parameters

          • this: void
          • value: Event
          • index: number
          • obj: Event[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Event, index: number, obj: Event[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Event | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Event, index: number, obj: Event[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Event, index: number, array: Event[]): void
        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Event, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Event

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Event, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Event

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Event, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Event

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Event, index: number, array: Event[]): U
        • Parameters

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Event | undefined
  • Removes the last element from an array and returns it.

    Returns Event | undefined

push

  • push(...items: Event[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Event[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Event
  • reduce(callbackfn: function, initialValue: Event): Event
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Event

  • Parameters

    • callbackfn: function
    • initialValue: Event

    Returns Event

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Event, currentIndex: number, array: Event[]): U
        • Parameters

          • previousValue: U
          • currentValue: Event
          • currentIndex: number
          • array: Event[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Event
  • reduceRight(callbackfn: function, initialValue: Event): Event
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Event

  • Parameters

    • callbackfn: function
    • initialValue: Event

    Returns Event

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Event, currentIndex: number, array: Event[]): U
        • Parameters

          • previousValue: U
          • currentValue: Event
          • currentIndex: number
          • array: Event[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Event[]

shift

  • shift(): Event | undefined
  • Removes the first element from an array and returns it.

    Returns Event | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Event[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Event[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Event, index: number, array: Event[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Event[]
  • splice(start: number, deleteCount: number, ...items: Event[]): Event[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Event[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Event[]

      Elements to insert into the array in place of the deleted elements.

    Returns Event[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Event[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Event[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Event>
  • Returns an iterable of values in the array

    Returns IterableIterator<Event>

type

type: object

className

className: string = "EventCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Event"

name

name: "Composite" = "Composite"

Const EventProperties

EventProperties: object
interface

An interface representing EventProperties. The properties of a monitoring event.

Optional affectedObjectFriendlyName

affectedObjectFriendlyName: undefined | string
member

{string} [affectedObjectFriendlyName] The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).

Optional description

description: undefined | string
member

{string} [description] The event name.

Optional eventCode

eventCode: undefined | string
member

{string} [eventCode] The Id of the monitoring event.

Optional eventSpecificDetails

eventSpecificDetails: EventSpecificDetailsUnion
member

{EventSpecificDetailsUnion} [eventSpecificDetails] The event specific settings.

Optional eventType

eventType: undefined | string
member

{string} [eventType] The type of the event. for example: VM Health, Server Health, Job Failure etc.

Optional fabricId

fabricId: undefined | string
member

{string} [fabricId] The ARM ID of the fabric.

Optional healthErrors

healthErrors: HealthError[]
member

{HealthError[]} [healthErrors] The list of errors / warnings capturing details associated with the issue(s).

Optional providerSpecificDetails

providerSpecificDetails: EventProviderSpecificDetailsUnion
member

{EventProviderSpecificDetailsUnion} [providerSpecificDetails] The provider specific settings.

Optional severity

severity: undefined | string
member

{string} [severity] The severity of the event.

Optional timeOfOccurrence

timeOfOccurrence: Date
member

{Date} [timeOfOccurrence] The time of occurence of the event.

serializedName

serializedName: string = "EventProperties"

type

type: object

className

className: string = "EventProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affectedObjectFriendlyName

affectedObjectFriendlyName: object

serializedName

serializedName: string = "affectedObjectFriendlyName"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

eventCode

eventCode: object

serializedName

serializedName: string = "eventCode"

type

type: object

name

name: "String" = "String"

eventSpecificDetails

eventSpecificDetails: object

serializedName

serializedName: string = "eventSpecificDetails"

type

type: object

className

className: string = "EventSpecificDetails"

name

name: "Composite" = "Composite"

eventType

eventType: object

serializedName

serializedName: string = "eventType"

type

type: object

name

name: "String" = "String"

fabricId

fabricId: object

serializedName

serializedName: string = "fabricId"

type

type: object

name

name: "String" = "String"

healthErrors

healthErrors: object

serializedName

serializedName: string = "healthErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "EventProviderSpecificDetails"

name

name: "Composite" = "Composite"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

name

name: "String" = "String"

timeOfOccurrence

timeOfOccurrence: object

serializedName

serializedName: string = "timeOfOccurrence"

type

type: object

name

name: "DateTime" = "DateTime"

Const EventProviderSpecificDetails

EventProviderSpecificDetails: object
interface

An interface representing EventProviderSpecificDetails. Model class for provider specific details for an event.

instanceType

instanceType: "EventProviderSpecificDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "EventProviderSpecificDetails"

type

type: object

className

className: string = "EventProviderSpecificDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const EventQueryParameter

EventQueryParameter: object
interface

An interface representing EventQueryParameter. Implements the event query parameter.

Optional affectedObjectFriendlyName

affectedObjectFriendlyName: undefined | string
member

{string} [affectedObjectFriendlyName] The affected object name of the events to be queried.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time of the time range within which the events are to be queried.

Optional eventCode

eventCode: undefined | string
member

{string} [eventCode] The source id of the events to be queried.

Optional eventType

eventType: undefined | string
member

{string} [eventType] The type of the events to be queried.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] The affected object server id of the events to be queried.

Optional severity

severity: undefined | string
member

{string} [severity] The severity of the events to be queried.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time of the time range within which the events are to be queried.

serializedName

serializedName: string = "EventQueryParameter"

type

type: object

className

className: string = "EventQueryParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affectedObjectFriendlyName

affectedObjectFriendlyName: object

serializedName

serializedName: string = "affectedObjectFriendlyName"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

eventCode

eventCode: object

serializedName

serializedName: string = "eventCode"

type

type: object

name

name: "String" = "String"

eventType

eventType: object

serializedName

serializedName: string = "eventType"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const EventSpecificDetails

EventSpecificDetails: object
interface

An interface representing EventSpecificDetails. Model class for event specific details for an event.

instanceType

instanceType: "EventSpecificDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "EventSpecificDetails"

type

type: object

className

className: string = "EventSpecificDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "EventSpecificDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ExportJobDetails

ExportJobDetails: object
interface

An interface representing ExportJobDetails. This class represents details for export jobs workflow.

Optional affectedObjectDetails

affectedObjectDetails: undefined | object
member

{{ [propertyName: string]: string }} [affectedObjectDetails] The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.

Optional blobUri

blobUri: undefined | string
member

{string} [blobUri] BlobUri of the exported jobs.

instanceType

instanceType: "ExportJobDetails"
member

{string} instanceType Polymorphic Discriminator

Optional sasToken

sasToken: undefined | string
member

{string} [sasToken] The sas token to access blob.

serializedName

serializedName: string = "ExportJobDetails"

type

type: object

className

className: string = "ExportJobDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobDetails"

modelProperties

modelProperties: object

blobUri

blobUri: object

serializedName

serializedName: string = "blobUri"

type

type: object

name

name: "String" = "String"

sasToken

sasToken: object

serializedName

serializedName: string = "sasToken"

type

type: object

name

name: "String" = "String"

Const Fabric

Fabric: object
interface

An interface representing Fabric. Fabric definition.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: FabricProperties
member

{FabricProperties} [properties] Fabric related data.

serializedName

serializedName: string = "Fabric"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Fabric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "FabricProperties"

name

name: "Composite" = "Composite"

Const FabricCollection

FabricCollection: object
interface

An interface representing the FabricCollection. Collection of fabric details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "FabricCollection"

__@iterator

  • __@iterator(): IterableIterator<Fabric>
  • Iterator

    Returns IterableIterator<Fabric>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Fabric>[]): Fabric[]
  • concat(...items: (T | ConcatArray<T>)[]): Fabric[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Fabric>[]

      Additional items to add to the end of array1.

    Returns Fabric[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Fabric[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Fabric]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Fabric]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Fabric, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Fabric

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Fabric[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Fabric[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Fabric | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Fabric, index: number, obj: Fabric[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Fabric | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Fabric, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Fabric

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Fabric, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Fabric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Fabric, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Fabric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Fabric | undefined

push

  • push(...items: Fabric[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Fabric[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Fabric
  • reduce(callbackfn: function, initialValue: Fabric): Fabric
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Fabric

  • Parameters

    Returns Fabric

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Fabric, currentIndex: number, array: Fabric[]): U
        • Parameters

          • previousValue: U
          • currentValue: Fabric
          • currentIndex: number
          • array: Fabric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Fabric
  • reduceRight(callbackfn: function, initialValue: Fabric): Fabric
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Fabric

  • Parameters

    Returns Fabric

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Fabric, currentIndex: number, array: Fabric[]): U
        • Parameters

          • previousValue: U
          • currentValue: Fabric
          • currentIndex: number
          • array: Fabric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Fabric[]

shift

  • Removes the first element from an array and returns it.

    Returns Fabric | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Fabric[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Fabric[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Fabric[]
  • splice(start: number, deleteCount: number, ...items: Fabric[]): Fabric[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Fabric[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Fabric[]

      Elements to insert into the array in place of the deleted elements.

    Returns Fabric[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Fabric[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Fabric[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Fabric>
  • Returns an iterable of values in the array

    Returns IterableIterator<Fabric>

type

type: object

className

className: string = "FabricCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Fabric"

name

name: "Composite" = "Composite"

Const FabricCreationInput

FabricCreationInput: object
interface

An interface representing FabricCreationInput. Site details provided during the time of site creation

Optional properties

member

{FabricCreationInputProperties} [properties] Fabric creation input.

serializedName

serializedName: string = "FabricCreationInput"

type

type: object

className

className: string = "FabricCreationInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "FabricCreationInputProperties"

name

name: "Composite" = "Composite"

Const FabricCreationInputProperties

FabricCreationInputProperties: object
interface

An interface representing FabricCreationInputProperties. Properties of site details provided during the time of site creation

Optional customDetails

member

{FabricSpecificCreationInputUnion} [customDetails] Fabric provider specific creation input.

serializedName

serializedName: string = "FabricCreationInputProperties"

type

type: object

className

className: string = "FabricCreationInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customDetails

customDetails: object

serializedName

serializedName: string = "customDetails"

type

type: object

className

className: string = "FabricSpecificCreationInput"

name

name: "Composite" = "Composite"

Const FabricProperties

FabricProperties: object
interface

An interface representing FabricProperties. Fabric properties.

Optional bcdrState

bcdrState: undefined | string
member

{string} [bcdrState] BCDR state of the fabric.

Optional customDetails

member

{FabricSpecificDetailsUnion} [customDetails] Fabric specific settings.

Optional encryptionDetails

encryptionDetails: EncryptionDetails
member

{EncryptionDetails} [encryptionDetails] Encryption details for the fabric.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the fabric.

Optional health

health: undefined | string
member

{string} [health] Health of fabric.

Optional healthErrorDetails

healthErrorDetails: HealthError[]
member

{HealthError[]} [healthErrorDetails] Fabric health error details.

Optional internalIdentifier

internalIdentifier: undefined | string
member

{string} [internalIdentifier] Dra Registration Id.

Optional rolloverEncryptionDetails

rolloverEncryptionDetails: EncryptionDetails
member

{EncryptionDetails} [rolloverEncryptionDetails] Rollover encryption details for the fabric.

serializedName

serializedName: string = "FabricProperties"

type

type: object

className

className: string = "FabricProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bcdrState

bcdrState: object

serializedName

serializedName: string = "bcdrState"

type

type: object

name

name: "String" = "String"

customDetails

customDetails: object

serializedName

serializedName: string = "customDetails"

type

type: object

className

className: string = "FabricSpecificDetails"

name

name: "Composite" = "Composite"

encryptionDetails

encryptionDetails: object

serializedName

serializedName: string = "encryptionDetails"

type

type: object

className

className: string = "EncryptionDetails"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

health

health: object

serializedName

serializedName: string = "health"

type

type: object

name

name: "String" = "String"

healthErrorDetails

healthErrorDetails: object

serializedName

serializedName: string = "healthErrorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

internalIdentifier

internalIdentifier: object

serializedName

serializedName: string = "internalIdentifier"

type

type: object

name

name: "String" = "String"

rolloverEncryptionDetails

rolloverEncryptionDetails: object

serializedName

serializedName: string = "rolloverEncryptionDetails"

type

type: object

className

className: string = "EncryptionDetails"

name

name: "Composite" = "Composite"

Const FabricReplicationGroupTaskDetails

FabricReplicationGroupTaskDetails: object
interface

An interface representing FabricReplicationGroupTaskDetails. This class represents the fabric replication group task details.

instanceType

instanceType: "FabricReplicationGroupTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional jobTask

jobTask: JobEntity
member

{JobEntity} [jobTask] The job entity.

Optional skippedReason

skippedReason: undefined | string
member

{string} [skippedReason] The skipped reason.

Optional skippedReasonString

skippedReasonString: undefined | string
member

{string} [skippedReasonString] The skipped reason string.

serializedName

serializedName: string = "FabricReplicationGroupTaskDetails"

type

type: object

className

className: string = "FabricReplicationGroupTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

jobTask

jobTask: object

serializedName

serializedName: string = "jobTask"

type

type: object

className

className: string = "JobEntity"

name

name: "Composite" = "Composite"

skippedReason

skippedReason: object

serializedName

serializedName: string = "skippedReason"

type

type: object

name

name: "String" = "String"

skippedReasonString

skippedReasonString: object

serializedName

serializedName: string = "skippedReasonString"

type

type: object

name

name: "String" = "String"

Const FabricSpecificCreateNetworkMappingInput

FabricSpecificCreateNetworkMappingInput: object
interface

An interface representing FabricSpecificCreateNetworkMappingInput. Input details specific to fabrics during Network Mapping.

instanceType

instanceType: "FabricSpecificCreateNetworkMappingInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "FabricSpecificCreateNetworkMappingInput"

type

type: object

className

className: string = "FabricSpecificCreateNetworkMappingInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FabricSpecificCreateNetworkMappingInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const FabricSpecificCreationInput

FabricSpecificCreationInput: object
interface

An interface representing FabricSpecificCreationInput. Fabric provider specific settings.

instanceType

instanceType: "FabricSpecificCreationInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "FabricSpecificCreationInput"

type

type: object

className

className: string = "FabricSpecificCreationInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FabricSpecificCreationInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const FabricSpecificDetails

FabricSpecificDetails: object
interface

An interface representing FabricSpecificDetails. Fabric specific details.

instanceType

instanceType: "FabricSpecificDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "FabricSpecificDetails"

type

type: object

className

className: string = "FabricSpecificDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FabricSpecificDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const FabricSpecificUpdateNetworkMappingInput

FabricSpecificUpdateNetworkMappingInput: object
interface

An interface representing FabricSpecificUpdateNetworkMappingInput. Input details specific to fabrics during Network Mapping.

instanceType

instanceType: "FabricSpecificUpdateNetworkMappingInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "FabricSpecificUpdateNetworkMappingInput"

type

type: object

className

className: string = "FabricSpecificUpdateNetworkMappingInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FabricSpecificUpdateNetworkMappingInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const FailoverJobDetails

FailoverJobDetails: object
interface

An interface representing FailoverJobDetails. This class represents the details for a failover job.

Optional affectedObjectDetails

affectedObjectDetails: undefined | object
member

{{ [propertyName: string]: string }} [affectedObjectDetails] The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.

instanceType

instanceType: "FailoverJobDetails"
member

{string} instanceType Polymorphic Discriminator

Optional protectedItemDetails

member

{FailoverReplicationProtectedItemDetails[]} [protectedItemDetails] The test VM details.

serializedName

serializedName: string = "FailoverJobDetails"

type

type: object

className

className: string = "FailoverJobDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobDetails"

modelProperties

modelProperties: object

protectedItemDetails

protectedItemDetails: object

serializedName

serializedName: string = "protectedItemDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FailoverReplicationProtectedItemDetails"

name

name: "Composite" = "Composite"

Const FailoverProcessServerRequest

FailoverProcessServerRequest: object
interface

An interface representing FailoverProcessServerRequest. Request to failover a process server.

Optional properties

member

{FailoverProcessServerRequestProperties} [properties] The properties of the PS Failover request.

serializedName

serializedName: string = "FailoverProcessServerRequest"

type

type: object

className

className: string = "FailoverProcessServerRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "FailoverProcessServerRequestProperties"

name

name: "Composite" = "Composite"

Const FailoverProcessServerRequestProperties

FailoverProcessServerRequestProperties: object
interface

An interface representing FailoverProcessServerRequestProperties. The properties of the Failover Process Server request.

Optional containerName

containerName: undefined | string
member

{string} [containerName] The container identifier.

Optional sourceProcessServerId

sourceProcessServerId: undefined | string
member

{string} [sourceProcessServerId] The source process server.

Optional targetProcessServerId

targetProcessServerId: undefined | string
member

{string} [targetProcessServerId] The new process server.

Optional updateType

updateType: undefined | string
member

{string} [updateType] A value for failover type. It can be systemlevel/serverlevel

Optional vmsToMigrate

vmsToMigrate: string[]
member

{string[]} [vmsToMigrate] The VMS to migrate.

serializedName

serializedName: string = "FailoverProcessServerRequestProperties"

type

type: object

className

className: string = "FailoverProcessServerRequestProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

sourceProcessServerId

sourceProcessServerId: object

serializedName

serializedName: string = "sourceProcessServerId"

type

type: object

name

name: "String" = "String"

targetProcessServerId

targetProcessServerId: object

serializedName

serializedName: string = "targetProcessServerId"

type

type: object

name

name: "String" = "String"

updateType

updateType: object

serializedName

serializedName: string = "updateType"

type

type: object

name

name: "String" = "String"

vmsToMigrate

vmsToMigrate: object

serializedName

serializedName: string = "vmsToMigrate"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const FailoverReplicationProtectedItemDetails

FailoverReplicationProtectedItemDetails: object
interface

An interface representing FailoverReplicationProtectedItemDetails. Failover details for a replication protected item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The friendly name.

Optional name

name: undefined | string
member

{string} [name] The name.

Optional networkConnectionStatus

networkConnectionStatus: undefined | string
member

{string} [networkConnectionStatus] The network connection status.

Optional networkFriendlyName

networkFriendlyName: undefined | string
member

{string} [networkFriendlyName] The network friendly name.

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] The recovery point Id.

Optional recoveryPointTime

recoveryPointTime: Date
member

{Date} [recoveryPointTime] The recovery point time.

Optional subnet

subnet: undefined | string
member

{string} [subnet] The network subnet.

Optional testVmFriendlyName

testVmFriendlyName: undefined | string
member

{string} [testVmFriendlyName] The test Vm friendly name.

Optional testVmName

testVmName: undefined | string
member

{string} [testVmName] The test Vm name.

serializedName

serializedName: string = "FailoverReplicationProtectedItemDetails"

type

type: object

className

className: string = "FailoverReplicationProtectedItemDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkConnectionStatus

networkConnectionStatus: object

serializedName

serializedName: string = "networkConnectionStatus"

type

type: object

name

name: "String" = "String"

networkFriendlyName

networkFriendlyName: object

serializedName

serializedName: string = "networkFriendlyName"

type

type: object

name

name: "String" = "String"

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

recoveryPointTime

recoveryPointTime: object

serializedName

serializedName: string = "recoveryPointTime"

type

type: object

name

name: "DateTime" = "DateTime"

subnet

subnet: object

serializedName

serializedName: string = "subnet"

type

type: object

name

name: "String" = "String"

testVmFriendlyName

testVmFriendlyName: object

serializedName

serializedName: string = "testVmFriendlyName"

type

type: object

name

name: "String" = "String"

testVmName

testVmName: object

serializedName

serializedName: string = "testVmName"

type

type: object

name

name: "String" = "String"

Const GroupTaskDetails

GroupTaskDetails: object
interface

An interface representing GroupTaskDetails. This class represents the group task details when parent child relationship exists in the drill down.

Optional childTasks

childTasks: ASRTask[]
member

{ASRTask[]} [childTasks] The child tasks.

instanceType

instanceType: "GroupTaskDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "GroupTaskDetails"

type

type: object

className

className: string = "GroupTaskDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "GroupTaskDetails"

modelProperties

modelProperties: object

childTasks

childTasks: object

serializedName

serializedName: string = "childTasks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ASRTask"

name

name: "Composite" = "Composite"

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const HealthError

HealthError: object
interface

An interface representing HealthError. Health Error

Optional creationTimeUtc

creationTimeUtc: Date
member

{Date} [creationTimeUtc] Error creation time (UTC)

Optional entityId

entityId: undefined | string
member

{string} [entityId] ID of the entity.

Optional errorCategory

errorCategory: undefined | string
member

{string} [errorCategory] Category of error.

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] Error code.

Optional errorLevel

errorLevel: undefined | string
member

{string} [errorLevel] Level of error.

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] Error message.

Optional errorSource

errorSource: undefined | string
member

{string} [errorSource] Source of error.

Optional errorType

errorType: undefined | string
member

{string} [errorType] Type of error.

Optional innerHealthErrors

innerHealthErrors: InnerHealthError[]
member

{InnerHealthError[]} [innerHealthErrors] The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.

Optional possibleCauses

possibleCauses: undefined | string
member

{string} [possibleCauses] Possible causes of error.

Optional recommendedAction

recommendedAction: undefined | string
member

{string} [recommendedAction] Recommended action to resolve error.

Optional recoveryProviderErrorMessage

recoveryProviderErrorMessage: undefined | string
member

{string} [recoveryProviderErrorMessage] DRA error message.

Optional summaryMessage

summaryMessage: undefined | string
member

{string} [summaryMessage] Summary message of the entity.

serializedName

serializedName: string = "HealthError"

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTimeUtc

creationTimeUtc: object

serializedName

serializedName: string = "creationTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

entityId

entityId: object

serializedName

serializedName: string = "entityId"

type

type: object

name

name: "String" = "String"

errorCategory

errorCategory: object

serializedName

serializedName: string = "errorCategory"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

errorLevel

errorLevel: object

serializedName

serializedName: string = "errorLevel"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

errorSource

errorSource: object

serializedName

serializedName: string = "errorSource"

type

type: object

name

name: "String" = "String"

errorType

errorType: object

serializedName

serializedName: string = "errorType"

type

type: object

name

name: "String" = "String"

innerHealthErrors

innerHealthErrors: object

serializedName

serializedName: string = "innerHealthErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InnerHealthError"

name

name: "Composite" = "Composite"

possibleCauses

possibleCauses: object

serializedName

serializedName: string = "possibleCauses"

type

type: object

name

name: "String" = "String"

recommendedAction

recommendedAction: object

serializedName

serializedName: string = "recommendedAction"

type

type: object

name

name: "String" = "String"

recoveryProviderErrorMessage

recoveryProviderErrorMessage: object

serializedName

serializedName: string = "recoveryProviderErrorMessage"

type

type: object

name

name: "String" = "String"

summaryMessage

summaryMessage: object

serializedName

serializedName: string = "summaryMessage"

type

type: object

name

name: "String" = "String"

Const HealthErrorSummary

HealthErrorSummary: object
interface

An interface representing HealthErrorSummary. class to define the summary of the health error details.

Optional affectedResourceCorrelationIds

affectedResourceCorrelationIds: string[]
member

{string[]} [affectedResourceCorrelationIds] The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.

Optional affectedResourceSubtype

affectedResourceSubtype: undefined | string
member

{string} [affectedResourceSubtype] The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.

Optional affectedResourceType

affectedResourceType: undefined | string
member

{string} [affectedResourceType] The type of affected ARM resource.

Optional category

member

{HealthErrorCategory} [category] The category of the health error. Possible values include: 'None', 'Replication', 'TestFailover', 'Configuration', 'FabricInfrastructure', 'VersionExpiry', 'AgentAutoUpdate'

Optional severity

severity: Severity
member

{Severity} [severity] Severity of error. Possible values include: 'NONE', 'Warning', 'Error', 'Info'

Optional summaryCode

summaryCode: undefined | string
member

{string} [summaryCode] The code of the health error.

Optional summaryMessage

summaryMessage: undefined | string
member

{string} [summaryMessage] The summary message of the health error.

serializedName

serializedName: string = "HealthErrorSummary"

type

type: object

className

className: string = "HealthErrorSummary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affectedResourceCorrelationIds

affectedResourceCorrelationIds: object

serializedName

serializedName: string = "affectedResourceCorrelationIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

affectedResourceSubtype

affectedResourceSubtype: object

serializedName

serializedName: string = "affectedResourceSubtype"

type

type: object

name

name: "String" = "String"

affectedResourceType

affectedResourceType: object

serializedName

serializedName: string = "affectedResourceType"

type

type: object

name

name: "String" = "String"

category

category: object

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

name

name: "String" = "String"

summaryCode

summaryCode: object

serializedName

serializedName: string = "summaryCode"

type

type: object

name

name: "String" = "String"

summaryMessage

summaryMessage: object

serializedName

serializedName: string = "summaryMessage"

type

type: object

name

name: "String" = "String"

Const HyperVReplica2012EventDetails

HyperVReplica2012EventDetails: object
interface

An interface representing HyperVReplica2012EventDetails. Model class for event details of a HyperVReplica E2E event.

Optional containerName

containerName: undefined | string
member

{string} [containerName] The container friendly name.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] The fabric friendly name.

instanceType

instanceType: "HyperVReplica2012"
member

{string} instanceType Polymorphic Discriminator

Optional remoteContainerName

remoteContainerName: undefined | string
member

{string} [remoteContainerName] The remote container name.

Optional remoteFabricName

remoteFabricName: undefined | string
member

{string} [remoteFabricName] The remote fabric name.

serializedName

serializedName: string = "HyperVReplica2012"

type

type: object

className

className: string = "HyperVReplica2012EventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

remoteContainerName

remoteContainerName: object

serializedName

serializedName: string = "remoteContainerName"

type

type: object

name

name: "String" = "String"

remoteFabricName

remoteFabricName: object

serializedName

serializedName: string = "remoteFabricName"

type

type: object

name

name: "String" = "String"

Const HyperVReplica2012R2EventDetails

HyperVReplica2012R2EventDetails: object
interface

An interface representing HyperVReplica2012R2EventDetails. Model class for event details of a HyperVReplica blue E2E event.

Optional containerName

containerName: undefined | string
member

{string} [containerName] The container friendly name.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] The fabric friendly name.

instanceType

instanceType: "HyperVReplica2012R2"
member

{string} instanceType Polymorphic Discriminator

Optional remoteContainerName

remoteContainerName: undefined | string
member

{string} [remoteContainerName] The remote container name.

Optional remoteFabricName

remoteFabricName: undefined | string
member

{string} [remoteFabricName] The remote fabric name.

serializedName

serializedName: string = "HyperVReplica2012R2"

type

type: object

className

className: string = "HyperVReplica2012R2EventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

remoteContainerName

remoteContainerName: object

serializedName

serializedName: string = "remoteContainerName"

type

type: object

name

name: "String" = "String"

remoteFabricName

remoteFabricName: object

serializedName

serializedName: string = "remoteFabricName"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureApplyRecoveryPointInput

HyperVReplicaAzureApplyRecoveryPointInput: object
interface

An interface representing HyperVReplicaAzureApplyRecoveryPointInput. ApplyRecoveryPoint input specific to HyperVReplicaAzure provider.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional primaryKekCertificatePfx

primaryKekCertificatePfx: undefined | string
member

{string} [primaryKekCertificatePfx] The primary kek certificate pfx.

Optional secondaryKekCertificatePfx

secondaryKekCertificatePfx: undefined | string
member

{string} [secondaryKekCertificatePfx] The secondary kek certificate pfx.

Optional vaultLocation

vaultLocation: undefined | string
member

{string} [vaultLocation] The vault location where the recovery Vm resides.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureApplyRecoveryPointInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ApplyRecoveryPointProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ApplyRecoveryPointProviderSpecificInput"

modelProperties

modelProperties: object

primaryKekCertificatePfx

primaryKekCertificatePfx: object

serializedName

serializedName: string = "primaryKekCertificatePfx"

type

type: object

name

name: "String" = "String"

secondaryKekCertificatePfx

secondaryKekCertificatePfx: object

serializedName

serializedName: string = "secondaryKekCertificatePfx"

type

type: object

name

name: "String" = "String"

vaultLocation

vaultLocation: object

serializedName

serializedName: string = "vaultLocation"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureEnableProtectionInput

HyperVReplicaAzureEnableProtectionInput: object
interface

An interface representing HyperVReplicaAzureEnableProtectionInput. Azure specific enable protection input.

Optional disksToInclude

disksToInclude: string[]
member

{string[]} [disksToInclude] The list of VHD IDs of disks to be protected.

Optional enableRdpOnTargetOption

enableRdpOnTargetOption: undefined | string
member

{string} [enableRdpOnTargetOption] The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.

Optional hvHostVmId

hvHostVmId: undefined | string
member

{string} [hvHostVmId] The Hyper-V host Vm Id.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional logStorageAccountId

logStorageAccountId: undefined | string
member

{string} [logStorageAccountId] The storage account to be used for logging during replication.

Optional osType

osType: undefined | string
member

{string} [osType] The OS type associated with vm.

Optional targetAzureNetworkId

targetAzureNetworkId: undefined | string
member

{string} [targetAzureNetworkId] The selected target Azure network Id.

Optional targetAzureSubnetId

targetAzureSubnetId: undefined | string
member

{string} [targetAzureSubnetId] The selected target Azure subnet Id.

Optional targetAzureV1ResourceGroupId

targetAzureV1ResourceGroupId: undefined | string
member

{string} [targetAzureV1ResourceGroupId] The Id of the target resource group (for classic deployment) in which the failover VM is to be created.

Optional targetAzureV2ResourceGroupId

targetAzureV2ResourceGroupId: undefined | string
member

{string} [targetAzureV2ResourceGroupId] The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.

Optional targetAzureVmName

targetAzureVmName: undefined | string
member

{string} [targetAzureVmName] The target azure Vm Name.

Optional targetStorageAccountId

targetStorageAccountId: undefined | string
member

{string} [targetStorageAccountId] The storage account name.

Optional useManagedDisks

useManagedDisks: undefined | string
member

{string} [useManagedDisks] A value indicating whether managed disks should be used during failover.

Optional vhdId

vhdId: undefined | string
member

{string} [vhdId] The OS disk VHD id associated with vm.

Optional vmName

vmName: undefined | string
member

{string} [vmName] The Vm Name.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureEnableProtectionInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EnableProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "EnableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

disksToInclude

disksToInclude: object

serializedName

serializedName: string = "disksToInclude"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

enableRdpOnTargetOption

enableRdpOnTargetOption: object

serializedName

serializedName: string = "enableRdpOnTargetOption"

type

type: object

name

name: "String" = "String"

hvHostVmId

hvHostVmId: object

serializedName

serializedName: string = "hvHostVmId"

type

type: object

name

name: "String" = "String"

logStorageAccountId

logStorageAccountId: object

serializedName

serializedName: string = "logStorageAccountId"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

targetAzureNetworkId

targetAzureNetworkId: object

serializedName

serializedName: string = "targetAzureNetworkId"

type

type: object

name

name: "String" = "String"

targetAzureSubnetId

targetAzureSubnetId: object

serializedName

serializedName: string = "targetAzureSubnetId"

type

type: object

name

name: "String" = "String"

targetAzureV1ResourceGroupId

targetAzureV1ResourceGroupId: object

serializedName

serializedName: string = "targetAzureV1ResourceGroupId"

type

type: object

name

name: "String" = "String"

targetAzureV2ResourceGroupId

targetAzureV2ResourceGroupId: object

serializedName

serializedName: string = "targetAzureV2ResourceGroupId"

type

type: object

name

name: "String" = "String"

targetAzureVmName

targetAzureVmName: object

serializedName

serializedName: string = "targetAzureVmName"

type

type: object

name

name: "String" = "String"

targetStorageAccountId

targetStorageAccountId: object

serializedName

serializedName: string = "targetStorageAccountId"

type

type: object

name

name: "String" = "String"

useManagedDisks

useManagedDisks: object

serializedName

serializedName: string = "useManagedDisks"

type

type: object

name

name: "String" = "String"

vhdId

vhdId: object

serializedName

serializedName: string = "vhdId"

type

type: object

name

name: "String" = "String"

vmName

vmName: object

serializedName

serializedName: string = "vmName"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureEventDetails

HyperVReplicaAzureEventDetails: object
interface

An interface representing HyperVReplicaAzureEventDetails. Model class for event details of a HyperVReplica E2A event.

Optional containerName

containerName: undefined | string
member

{string} [containerName] The container friendly name.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] The fabric friendly name.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional remoteContainerName

remoteContainerName: undefined | string
member

{string} [remoteContainerName] The remote container name.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureEventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

remoteContainerName

remoteContainerName: object

serializedName

serializedName: string = "remoteContainerName"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureFailbackProviderInput

HyperVReplicaAzureFailbackProviderInput: object
interface

An interface representing HyperVReplicaAzureFailbackProviderInput. HvrA provider specific input for failback.

Optional dataSyncOption

dataSyncOption: undefined | string
member

{string} [dataSyncOption] Data sync option.

instanceType

instanceType: "HyperVReplicaAzureFailback"
member

{string} instanceType Polymorphic Discriminator

Optional providerIdForAlternateRecovery

providerIdForAlternateRecovery: undefined | string
member

{string} [providerIdForAlternateRecovery] Provider ID for alternate location

Optional recoveryVmCreationOption

recoveryVmCreationOption: undefined | string
member

{string} [recoveryVmCreationOption] ALR options to create alternate recovery.

serializedName

serializedName: string = "HyperVReplicaAzureFailback"

type

type: object

className

className: string = "HyperVReplicaAzureFailbackProviderInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificFailoverInput"

modelProperties

modelProperties: object

dataSyncOption

dataSyncOption: object

serializedName

serializedName: string = "dataSyncOption"

type

type: object

name

name: "String" = "String"

providerIdForAlternateRecovery

providerIdForAlternateRecovery: object

serializedName

serializedName: string = "providerIdForAlternateRecovery"

type

type: object

name

name: "String" = "String"

recoveryVmCreationOption

recoveryVmCreationOption: object

serializedName

serializedName: string = "recoveryVmCreationOption"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureFailoverProviderInput

HyperVReplicaAzureFailoverProviderInput: object
interface

An interface representing HyperVReplicaAzureFailoverProviderInput. HvrA provider specific input for failover.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional primaryKekCertificatePfx

primaryKekCertificatePfx: undefined | string
member

{string} [primaryKekCertificatePfx] Primary kek certificate pfx.

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.

Optional secondaryKekCertificatePfx

secondaryKekCertificatePfx: undefined | string
member

{string} [secondaryKekCertificatePfx] Secondary kek certificate pfx.

Optional vaultLocation

vaultLocation: undefined | string
member

{string} [vaultLocation] Location of the vault.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureFailoverProviderInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificFailoverInput"

modelProperties

modelProperties: object

primaryKekCertificatePfx

primaryKekCertificatePfx: object

serializedName

serializedName: string = "primaryKekCertificatePfx"

type

type: object

name

name: "String" = "String"

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

secondaryKekCertificatePfx

secondaryKekCertificatePfx: object

serializedName

serializedName: string = "secondaryKekCertificatePfx"

type

type: object

name

name: "String" = "String"

vaultLocation

vaultLocation: object

serializedName

serializedName: string = "vaultLocation"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzurePolicyDetails

HyperVReplicaAzurePolicyDetails: object
interface

An interface representing HyperVReplicaAzurePolicyDetails. Hyper-V Replica Azure specific protection profile details.

Optional activeStorageAccountId

activeStorageAccountId: undefined | string
member

{string} [activeStorageAccountId] The active storage account Id.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.

Optional encryption

encryption: undefined | string
member

{string} [encryption] A value indicating whether encryption is enabled for virtual machines in this cloud.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.

Optional recoveryPointHistoryDurationInHours

recoveryPointHistoryDurationInHours: undefined | number
member

{number} [recoveryPointHistoryDurationInHours] The duration (in hours) to which point the recovery history needs to be maintained.

Optional replicationInterval

replicationInterval: undefined | number
member

{number} [replicationInterval] The replication interval.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzurePolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

activeStorageAccountId

activeStorageAccountId: object

serializedName

serializedName: string = "activeStorageAccountId"

type

type: object

name

name: "String" = "String"

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

encryption

encryption: object

serializedName

serializedName: string = "encryption"

type

type: object

name

name: "String" = "String"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPointHistoryDurationInHours

recoveryPointHistoryDurationInHours: object

serializedName

serializedName: string = "recoveryPointHistoryDurationInHours"

type

type: object

name

name: "Number" = "Number"

replicationInterval

replicationInterval: object

serializedName

serializedName: string = "replicationInterval"

type

type: object

name

name: "Number" = "Number"

Const HyperVReplicaAzurePolicyInput

HyperVReplicaAzurePolicyInput: object
interface

An interface representing HyperVReplicaAzurePolicyInput. Hyper-V Replica Azure specific input for creating a protection profile.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.

Optional recoveryPointHistoryDuration

recoveryPointHistoryDuration: undefined | number
member

{number} [recoveryPointHistoryDuration] The duration (in hours) to which point the recovery history needs to be maintained.

Optional replicationInterval

replicationInterval: undefined | number
member

{number} [replicationInterval] The replication interval.

Optional storageAccounts

storageAccounts: string[]
member

{string[]} [storageAccounts] The list of storage accounts to which the VMs in the primary cloud can replicate to.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzurePolicyInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPointHistoryDuration

recoveryPointHistoryDuration: object

serializedName

serializedName: string = "recoveryPointHistoryDuration"

type

type: object

name

name: "Number" = "Number"

replicationInterval

replicationInterval: object

serializedName

serializedName: string = "replicationInterval"

type

type: object

name

name: "Number" = "Number"

storageAccounts

storageAccounts: object

serializedName

serializedName: string = "storageAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureReplicationDetails

HyperVReplicaAzureReplicationDetails: object
interface

An interface representing HyperVReplicaAzureReplicationDetails. Hyper V Replica Azure provider specific settings.

Optional azureVmDiskDetails

azureVmDiskDetails: AzureVmDiskDetails[]
member

{AzureVmDiskDetails[]} [azureVmDiskDetails] Azure VM Disk details.

Optional enableRdpOnTargetOption

enableRdpOnTargetOption: undefined | string
member

{string} [enableRdpOnTargetOption] The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.

Optional encryption

encryption: undefined | string
member

{string} [encryption] The encryption info.

Optional initialReplicationDetails

initialReplicationDetails: InitialReplicationDetails
member

{InitialReplicationDetails} [initialReplicationDetails] Initial replication details.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional lastReplicatedTime

lastReplicatedTime: Date
member

{Date} [lastReplicatedTime] The Last replication time.

Optional lastRpoCalculatedTime

lastRpoCalculatedTime: Date
member

{Date} [lastRpoCalculatedTime] The last RPO calculated time.

Optional licenseType

licenseType: undefined | string
member

{string} [licenseType] License Type of the VM to be used.

Optional oSDetails

oSDetails: OSDetails
member

{OSDetails} [oSDetails] The operating system info.

Optional recoveryAvailabilitySetId

recoveryAvailabilitySetId: undefined | string
member

{string} [recoveryAvailabilitySetId] The recovery availability set Id.

Optional recoveryAzureLogStorageAccountId

recoveryAzureLogStorageAccountId: undefined | string
member

{string} [recoveryAzureLogStorageAccountId] The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.

Optional recoveryAzureResourceGroupId

recoveryAzureResourceGroupId: undefined | string
member

{string} [recoveryAzureResourceGroupId] The target resource group Id.

Optional recoveryAzureStorageAccount

recoveryAzureStorageAccount: undefined | string
member

{string} [recoveryAzureStorageAccount] The recovery Azure storage account.

Optional recoveryAzureVMSize

recoveryAzureVMSize: undefined | string
member

{string} [recoveryAzureVMSize] The Recovery Azure VM size.

Optional recoveryAzureVmName

recoveryAzureVmName: undefined | string
member

{string} [recoveryAzureVmName] Recovery Azure given name.

Optional rpoInSeconds

rpoInSeconds: undefined | number
member

{number} [rpoInSeconds] Last RPO value.

Optional selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: undefined | string
member

{string} [selectedRecoveryAzureNetworkId] The selected recovery azure network Id.

Optional selectedSourceNicId

selectedSourceNicId: undefined | string
member

{string} [selectedSourceNicId] The selected source nic Id which will be used as the primary nic during failover.

Optional sourceVmCpuCount

sourceVmCpuCount: undefined | number
member

{number} [sourceVmCpuCount] The CPU count of the VM on the primary side.

Optional sourceVmRamSizeInMB

sourceVmRamSizeInMB: undefined | number
member

{number} [sourceVmRamSizeInMB] The RAM size of the VM on the primary side.

Optional useManagedDisks

useManagedDisks: undefined | string
member

{string} [useManagedDisks] A value indicating whether managed disks should be used during failover.

Optional vmId

vmId: undefined | string
member

{string} [vmId] The virtual machine Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The PE Network details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

azureVmDiskDetails

azureVmDiskDetails: object

serializedName

serializedName: string = "azureVmDiskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureVmDiskDetails"

name

name: "Composite" = "Composite"

enableRdpOnTargetOption

enableRdpOnTargetOption: object

serializedName

serializedName: string = "enableRdpOnTargetOption"

type

type: object

name

name: "String" = "String"

encryption

encryption: object

serializedName

serializedName: string = "encryption"

type

type: object

name

name: "String" = "String"

initialReplicationDetails

initialReplicationDetails: object

serializedName

serializedName: string = "initialReplicationDetails"

type

type: object

className

className: string = "InitialReplicationDetails"

name

name: "Composite" = "Composite"

lastReplicatedTime

lastReplicatedTime: object

serializedName

serializedName: string = "lastReplicatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastRpoCalculatedTime

lastRpoCalculatedTime: object

serializedName

serializedName: string = "lastRpoCalculatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

licenseType

licenseType: object

serializedName

serializedName: string = "licenseType"

type

type: object

name

name: "String" = "String"

oSDetails

oSDetails: object

serializedName

serializedName: string = "oSDetails"

type

type: object

className

className: string = "OSDetails"

name

name: "Composite" = "Composite"

recoveryAvailabilitySetId

recoveryAvailabilitySetId: object

serializedName

serializedName: string = "recoveryAvailabilitySetId"

type

type: object

name

name: "String" = "String"

recoveryAzureLogStorageAccountId

recoveryAzureLogStorageAccountId: object

serializedName

serializedName: string = "recoveryAzureLogStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryAzureResourceGroupId

recoveryAzureResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryAzureStorageAccount

recoveryAzureStorageAccount: object

serializedName

serializedName: string = "recoveryAzureStorageAccount"

type

type: object

name

name: "String" = "String"

recoveryAzureVMSize

recoveryAzureVMSize: object

serializedName

serializedName: string = "recoveryAzureVMSize"

type

type: object

name

name: "String" = "String"

recoveryAzureVmName

recoveryAzureVmName: object

serializedName

serializedName: string = "recoveryAzureVmName"

type

type: object

name

name: "String" = "String"

rpoInSeconds

rpoInSeconds: object

serializedName

serializedName: string = "rpoInSeconds"

type

type: object

name

name: "Number" = "Number"

selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: object

serializedName

serializedName: string = "selectedRecoveryAzureNetworkId"

type

type: object

name

name: "String" = "String"

selectedSourceNicId

selectedSourceNicId: object

serializedName

serializedName: string = "selectedSourceNicId"

type

type: object

name

name: "String" = "String"

sourceVmCpuCount

sourceVmCpuCount: object

serializedName

serializedName: string = "sourceVmCpuCount"

type

type: object

name

name: "Number" = "Number"

sourceVmRamSizeInMB

sourceVmRamSizeInMB: object

serializedName

serializedName: string = "sourceVmRamSizeInMB"

type

type: object

name

name: "Number" = "Number"

useManagedDisks

useManagedDisks: object

serializedName

serializedName: string = "useManagedDisks"

type

type: object

name

name: "String" = "String"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureReprotectInput

HyperVReplicaAzureReprotectInput: object
interface

An interface representing HyperVReplicaAzureReprotectInput. Azure specific reprotect input.

Optional hvHostVmId

hvHostVmId: undefined | string
member

{string} [hvHostVmId] The Hyper-V host Vm Id.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional logStorageAccountId

logStorageAccountId: undefined | string
member

{string} [logStorageAccountId] The storage account to be used for logging during replication.

Optional osType

osType: undefined | string
member

{string} [osType] The OS type associated with vm.

Optional storageAccountId

storageAccountId: undefined | string
member

{string} [storageAccountId] The storage account name.

Optional vHDId

vHDId: undefined | string
member

{string} [vHDId] The OS disk VHD id associated with vm.

Optional vmName

vmName: undefined | string
member

{string} [vmName] The Vm Name.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureReprotectInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReverseReplicationProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReverseReplicationProviderSpecificInput"

modelProperties

modelProperties: object

hvHostVmId

hvHostVmId: object

serializedName

serializedName: string = "hvHostVmId"

type

type: object

name

name: "String" = "String"

logStorageAccountId

logStorageAccountId: object

serializedName

serializedName: string = "logStorageAccountId"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "storageAccountId"

type

type: object

name

name: "String" = "String"

vHDId

vHDId: object

serializedName

serializedName: string = "vHDId"

type

type: object

name

name: "String" = "String"

vmName

vmName: object

serializedName

serializedName: string = "vmName"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaAzureUpdateReplicationProtectedItemInput

HyperVReplicaAzureUpdateReplicationProtectedItemInput: object
interface

An interface representing HyperVReplicaAzureUpdateReplicationProtectedItemInput. HyperV replica Azure input to update replication protected item.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryAzureV1ResourceGroupId

recoveryAzureV1ResourceGroupId: undefined | string
member

{string} [recoveryAzureV1ResourceGroupId] The recovery Azure resource group Id for classic deployment.

Optional recoveryAzureV2ResourceGroupId

recoveryAzureV2ResourceGroupId: undefined | string
member

{string} [recoveryAzureV2ResourceGroupId] The recovery Azure resource group Id for resource manager deployment.

Optional useManagedDisks

useManagedDisks: undefined | string
member

{string} [useManagedDisks] A value indicating whether managed disks should be used during failover.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "HyperVReplicaAzureUpdateReplicationProtectedItemInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = UpdateReplicationProtectedItemProviderInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "UpdateReplicationProtectedItemProviderInput"

modelProperties

modelProperties: object

recoveryAzureV1ResourceGroupId

recoveryAzureV1ResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureV1ResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryAzureV2ResourceGroupId

recoveryAzureV2ResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureV2ResourceGroupId"

type

type: object

name

name: "String" = "String"

useManagedDisks

useManagedDisks: object

serializedName

serializedName: string = "useManagedDisks"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaBaseEventDetails

HyperVReplicaBaseEventDetails: object
interface

An interface representing HyperVReplicaBaseEventDetails. Abstract model class for event details of a HyperVReplica E2E event.

Optional containerName

containerName: undefined | string
member

{string} [containerName] The container friendly name.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] The fabric friendly name.

instanceType

instanceType: "HyperVReplicaBaseEventDetails"
member

{string} instanceType Polymorphic Discriminator

Optional remoteContainerName

remoteContainerName: undefined | string
member

{string} [remoteContainerName] The remote container name.

Optional remoteFabricName

remoteFabricName: undefined | string
member

{string} [remoteFabricName] The remote fabric name.

serializedName

serializedName: string = "HyperVReplicaBaseEventDetails"

type

type: object

className

className: string = "HyperVReplicaBaseEventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

remoteContainerName

remoteContainerName: object

serializedName

serializedName: string = "remoteContainerName"

type

type: object

name

name: "String" = "String"

remoteFabricName

remoteFabricName: object

serializedName

serializedName: string = "remoteFabricName"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaBasePolicyDetails

HyperVReplicaBasePolicyDetails: object
interface

An interface representing HyperVReplicaBasePolicyDetails. Base class for HyperVReplica policy details.

Optional allowedAuthenticationType

allowedAuthenticationType: undefined | number
member

{number} [allowedAuthenticationType] A value indicating the authentication type.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] A value indicating the application consistent frequency.

Optional compression

compression: undefined | string
member

{string} [compression] A value indicating whether compression has to be enabled.

Optional initialReplicationMethod

initialReplicationMethod: undefined | string
member

{string} [initialReplicationMethod] A value indicating whether IR is online.

instanceType

instanceType: "HyperVReplicaBasePolicyDetails"
member

{string} instanceType Polymorphic Discriminator

Optional offlineReplicationExportPath

offlineReplicationExportPath: undefined | string
member

{string} [offlineReplicationExportPath] A value indicating the offline IR export path.

Optional offlineReplicationImportPath

offlineReplicationImportPath: undefined | string
member

{string} [offlineReplicationImportPath] A value indicating the offline IR import path.

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] A value indicating the online IR start time.

Optional recoveryPoints

recoveryPoints: undefined | number
member

{number} [recoveryPoints] A value indicating the number of recovery points.

Optional replicaDeletionOption

replicaDeletionOption: undefined | string
member

{string} [replicaDeletionOption] A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud

Optional replicationPort

replicationPort: undefined | number
member

{number} [replicationPort] A value indicating the recovery HTTPS port.

serializedName

serializedName: string = "HyperVReplicaBasePolicyDetails"

type

type: object

className

className: string = "HyperVReplicaBasePolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

allowedAuthenticationType

allowedAuthenticationType: object

serializedName

serializedName: string = "allowedAuthenticationType"

type

type: object

name

name: "Number" = "Number"

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

compression

compression: object

serializedName

serializedName: string = "compression"

type

type: object

name

name: "String" = "String"

initialReplicationMethod

initialReplicationMethod: object

serializedName

serializedName: string = "initialReplicationMethod"

type

type: object

name

name: "String" = "String"

offlineReplicationExportPath

offlineReplicationExportPath: object

serializedName

serializedName: string = "offlineReplicationExportPath"

type

type: object

name

name: "String" = "String"

offlineReplicationImportPath

offlineReplicationImportPath: object

serializedName

serializedName: string = "offlineReplicationImportPath"

type

type: object

name

name: "String" = "String"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPoints

recoveryPoints: object

serializedName

serializedName: string = "recoveryPoints"

type

type: object

name

name: "Number" = "Number"

replicaDeletionOption

replicaDeletionOption: object

serializedName

serializedName: string = "replicaDeletionOption"

type

type: object

name

name: "String" = "String"

replicationPort

replicationPort: object

serializedName

serializedName: string = "replicationPort"

type

type: object

name

name: "Number" = "Number"

Const HyperVReplicaBaseReplicationDetails

HyperVReplicaBaseReplicationDetails: object
interface

An interface representing HyperVReplicaBaseReplicationDetails. Hyper V replica provider specific settings base class.

Optional initialReplicationDetails

initialReplicationDetails: InitialReplicationDetails
member

{InitialReplicationDetails} [initialReplicationDetails] Initial replication details.

instanceType

instanceType: "HyperVReplicaBaseReplicationDetails"
member

{string} instanceType Polymorphic Discriminator

Optional lastReplicatedTime

lastReplicatedTime: Date
member

{Date} [lastReplicatedTime] The Last replication time.

Optional vMDiskDetails

vMDiskDetails: DiskDetails[]
member

{DiskDetails[]} [vMDiskDetails] VM disk details.

Optional vmId

vmId: undefined | string
member

{string} [vmId] The virtual machine Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The PE Network details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

serializedName

serializedName: string = "HyperVReplicaBaseReplicationDetails"

type

type: object

className

className: string = "HyperVReplicaBaseReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

initialReplicationDetails

initialReplicationDetails: object

serializedName

serializedName: string = "initialReplicationDetails"

type

type: object

className

className: string = "InitialReplicationDetails"

name

name: "Composite" = "Composite"

lastReplicatedTime

lastReplicatedTime: object

serializedName

serializedName: string = "lastReplicatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

vMDiskDetails

vMDiskDetails: object

serializedName

serializedName: string = "vMDiskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskDetails"

name

name: "Composite" = "Composite"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaBluePolicyDetails

HyperVReplicaBluePolicyDetails: object
interface

An interface representing HyperVReplicaBluePolicyDetails. Hyper-V Replica Blue specific protection profile details.

Optional allowedAuthenticationType

allowedAuthenticationType: undefined | number
member

{number} [allowedAuthenticationType] A value indicating the authentication type.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] A value indicating the application consistent frequency.

Optional compression

compression: undefined | string
member

{string} [compression] A value indicating whether compression has to be enabled.

Optional initialReplicationMethod

initialReplicationMethod: undefined | string
member

{string} [initialReplicationMethod] A value indicating whether IR is online.

instanceType

instanceType: "HyperVReplica2012R2"
member

{string} instanceType Polymorphic Discriminator

Optional offlineReplicationExportPath

offlineReplicationExportPath: undefined | string
member

{string} [offlineReplicationExportPath] A value indicating the offline IR export path.

Optional offlineReplicationImportPath

offlineReplicationImportPath: undefined | string
member

{string} [offlineReplicationImportPath] A value indicating the offline IR import path.

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] A value indicating the online IR start time.

Optional recoveryPoints

recoveryPoints: undefined | number
member

{number} [recoveryPoints] A value indicating the number of recovery points.

Optional replicaDeletionOption

replicaDeletionOption: undefined | string
member

{string} [replicaDeletionOption] A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud

Optional replicationFrequencyInSeconds

replicationFrequencyInSeconds: undefined | number
member

{number} [replicationFrequencyInSeconds] A value indicating the replication interval.

Optional replicationPort

replicationPort: undefined | number
member

{number} [replicationPort] A value indicating the recovery HTTPS port.

serializedName

serializedName: string = "HyperVReplica2012R2"

type

type: object

className

className: string = "HyperVReplicaBluePolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

allowedAuthenticationType

allowedAuthenticationType: object

serializedName

serializedName: string = "allowedAuthenticationType"

type

type: object

name

name: "Number" = "Number"

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

compression

compression: object

serializedName

serializedName: string = "compression"

type

type: object

name

name: "String" = "String"

initialReplicationMethod

initialReplicationMethod: object

serializedName

serializedName: string = "initialReplicationMethod"

type

type: object

name

name: "String" = "String"

offlineReplicationExportPath

offlineReplicationExportPath: object

serializedName

serializedName: string = "offlineReplicationExportPath"

type

type: object

name

name: "String" = "String"

offlineReplicationImportPath

offlineReplicationImportPath: object

serializedName

serializedName: string = "offlineReplicationImportPath"

type

type: object

name

name: "String" = "String"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPoints

recoveryPoints: object

serializedName

serializedName: string = "recoveryPoints"

type

type: object

name

name: "Number" = "Number"

replicaDeletionOption

replicaDeletionOption: object

serializedName

serializedName: string = "replicaDeletionOption"

type

type: object

name

name: "String" = "String"

replicationFrequencyInSeconds

replicationFrequencyInSeconds: object

serializedName

serializedName: string = "replicationFrequencyInSeconds"

type

type: object

name

name: "Number" = "Number"

replicationPort

replicationPort: object

serializedName

serializedName: string = "replicationPort"

type

type: object

name

name: "Number" = "Number"

Const HyperVReplicaBluePolicyInput

HyperVReplicaBluePolicyInput: object
interface

An interface representing HyperVReplicaBluePolicyInput. HyperV Replica Blue policy input.

Optional allowedAuthenticationType

allowedAuthenticationType: undefined | number
member

{number} [allowedAuthenticationType] A value indicating the authentication type.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] A value indicating the application consistent frequency.

Optional compression

compression: undefined | string
member

{string} [compression] A value indicating whether compression has to be enabled.

Optional initialReplicationMethod

initialReplicationMethod: undefined | string
member

{string} [initialReplicationMethod] A value indicating whether IR is online.

instanceType

instanceType: "HyperVReplica2012R2"
member

{string} instanceType Polymorphic Discriminator

Optional offlineReplicationExportPath

offlineReplicationExportPath: undefined | string
member

{string} [offlineReplicationExportPath] A value indicating the offline IR export path.

Optional offlineReplicationImportPath

offlineReplicationImportPath: undefined | string
member

{string} [offlineReplicationImportPath] A value indicating the offline IR import path.

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] A value indicating the online IR start time.

Optional recoveryPoints

recoveryPoints: undefined | number
member

{number} [recoveryPoints] A value indicating the number of recovery points.

Optional replicaDeletion

replicaDeletion: undefined | string
member

{string} [replicaDeletion] A value indicating whether the VM has to be auto deleted.

Optional replicationFrequencyInSeconds

replicationFrequencyInSeconds: undefined | number
member

{number} [replicationFrequencyInSeconds] A value indicating the replication interval.

Optional replicationPort

replicationPort: undefined | number
member

{number} [replicationPort] A value indicating the recovery HTTPS port.

serializedName

serializedName: string = "HyperVReplica2012R2"

type

type: object

className

className: string = "HyperVReplicaBluePolicyInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

allowedAuthenticationType

allowedAuthenticationType: object

serializedName

serializedName: string = "allowedAuthenticationType"

type

type: object

name

name: "Number" = "Number"

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

compression

compression: object

serializedName

serializedName: string = "compression"

type

type: object

name

name: "String" = "String"

initialReplicationMethod

initialReplicationMethod: object

serializedName

serializedName: string = "initialReplicationMethod"

type

type: object

name

name: "String" = "String"

offlineReplicationExportPath

offlineReplicationExportPath: object

serializedName

serializedName: string = "offlineReplicationExportPath"

type

type: object

name

name: "String" = "String"

offlineReplicationImportPath

offlineReplicationImportPath: object

serializedName

serializedName: string = "offlineReplicationImportPath"

type

type: object

name

name: "String" = "String"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPoints

recoveryPoints: object

serializedName

serializedName: string = "recoveryPoints"

type

type: object

name

name: "Number" = "Number"

replicaDeletion

replicaDeletion: object

serializedName

serializedName: string = "replicaDeletion"

type

type: object

name

name: "String" = "String"

replicationFrequencyInSeconds

replicationFrequencyInSeconds: object

serializedName

serializedName: string = "replicationFrequencyInSeconds"

type

type: object

name

name: "Number" = "Number"

replicationPort

replicationPort: object

serializedName

serializedName: string = "replicationPort"

type

type: object

name

name: "Number" = "Number"

Const HyperVReplicaBlueReplicationDetails

HyperVReplicaBlueReplicationDetails: object
interface

An interface representing HyperVReplicaBlueReplicationDetails. HyperV replica 2012 R2 (Blue) replication details.

Optional initialReplicationDetails

initialReplicationDetails: InitialReplicationDetails
member

{InitialReplicationDetails} [initialReplicationDetails] Initial replication details.

instanceType

instanceType: "HyperVReplica2012R2"
member

{string} instanceType Polymorphic Discriminator

Optional lastReplicatedTime

lastReplicatedTime: Date
member

{Date} [lastReplicatedTime] The Last replication time.

Optional vMDiskDetails

vMDiskDetails: DiskDetails[]
member

{DiskDetails[]} [vMDiskDetails] VM disk details.

Optional vmId

vmId: undefined | string
member

{string} [vmId] The virtual machine Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The PE Network details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

serializedName

serializedName: string = "HyperVReplica2012R2"

type

type: object

className

className: string = "HyperVReplicaBlueReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

initialReplicationDetails

initialReplicationDetails: object

serializedName

serializedName: string = "initialReplicationDetails"

type

type: object

className

className: string = "InitialReplicationDetails"

name

name: "Composite" = "Composite"

lastReplicatedTime

lastReplicatedTime: object

serializedName

serializedName: string = "lastReplicatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

vMDiskDetails

vMDiskDetails: object

serializedName

serializedName: string = "vMDiskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskDetails"

name

name: "Composite" = "Composite"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

Const HyperVReplicaPolicyDetails

HyperVReplicaPolicyDetails: object
interface

An interface representing HyperVReplicaPolicyDetails. Hyper-V Replica Blue specific protection profile details.

Optional allowedAuthenticationType

allowedAuthenticationType: undefined | number
member

{number} [allowedAuthenticationType] A value indicating the authentication type.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] A value indicating the application consistent frequency.

Optional compression

compression: undefined | string
member

{string} [compression] A value indicating whether compression has to be enabled.

Optional initialReplicationMethod

initialReplicationMethod: undefined | string
member

{string} [initialReplicationMethod] A value indicating whether IR is online.

instanceType

instanceType: "HyperVReplica2012"
member

{string} instanceType Polymorphic Discriminator

Optional offlineReplicationExportPath

offlineReplicationExportPath: undefined | string
member

{string} [offlineReplicationExportPath] A value indicating the offline IR export path.

Optional offlineReplicationImportPath

offlineReplicationImportPath: undefined | string
member

{string} [offlineReplicationImportPath] A value indicating the offline IR import path.

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] A value indicating the online IR start time.

Optional recoveryPoints

recoveryPoints: undefined | number
member

{number} [recoveryPoints] A value indicating the number of recovery points.

Optional replicaDeletionOption

replicaDeletionOption: undefined | string
member

{string} [replicaDeletionOption] A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud

Optional replicationPort

replicationPort: undefined | number
member

{number} [replicationPort] A value indicating the recovery HTTPS port.

serializedName

serializedName: string = "HyperVReplica2012"

type

type: object

className

className: string = "HyperVReplicaPolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

allowedAuthenticationType

allowedAuthenticationType: object

serializedName

serializedName: string = "allowedAuthenticationType"

type

type: object

name

name: "Number" = "Number"

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

compression

compression: object

serializedName

serializedName: string = "compression"

type

type: object

name

name: "String" = "String"

initialReplicationMethod

initialReplicationMethod: object

serializedName

serializedName: string = "initialReplicationMethod"

type

type: object

name

name: "String" = "String"

offlineReplicationExportPath

offlineReplicationExportPath: object

serializedName

serializedName: string = "offlineReplicationExportPath"

type

type: object

name

name: "String" = "String"

offlineReplicationImportPath

offlineReplicationImportPath: object

serializedName

serializedName: string = "offlineReplicationImportPath"

type

type: object

name

name: "String" = "String"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPoints

recoveryPoints: object

serializedName

serializedName: string = "recoveryPoints"

type

type: object

name

name: "Number" = "Number"

replicaDeletionOption

replicaDeletionOption: object

serializedName

serializedName: string = "replicaDeletionOption"

type

type: object

name

name: "String" = "String"

replicationPort

replicationPort: object

serializedName

serializedName: string = "replicationPort"

type

type: object

name

name: "Number" = "Number"

Const HyperVReplicaPolicyInput

HyperVReplicaPolicyInput: object
interface

An interface representing HyperVReplicaPolicyInput. Hyper-V Replica specific policy Input.

Optional allowedAuthenticationType

allowedAuthenticationType: undefined | number
member

{number} [allowedAuthenticationType] A value indicating the authentication type.

Optional applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: undefined | number
member

{number} [applicationConsistentSnapshotFrequencyInHours] A value indicating the application consistent frequency.

Optional compression

compression: undefined | string
member

{string} [compression] A value indicating whether compression has to be enabled.

Optional initialReplicationMethod

initialReplicationMethod: undefined | string
member

{string} [initialReplicationMethod] A value indicating whether IR is online.

instanceType

instanceType: "HyperVReplica2012"
member

{string} instanceType Polymorphic Discriminator

Optional offlineReplicationExportPath

offlineReplicationExportPath: undefined | string
member

{string} [offlineReplicationExportPath] A value indicating the offline IR export path.

Optional offlineReplicationImportPath

offlineReplicationImportPath: undefined | string
member

{string} [offlineReplicationImportPath] A value indicating the offline IR import path.

Optional onlineReplicationStartTime

onlineReplicationStartTime: undefined | string
member

{string} [onlineReplicationStartTime] A value indicating the online IR start time.

Optional recoveryPoints

recoveryPoints: undefined | number
member

{number} [recoveryPoints] A value indicating the number of recovery points.

Optional replicaDeletion

replicaDeletion: undefined | string
member

{string} [replicaDeletion] A value indicating whether the VM has to be auto deleted.

Optional replicationPort

replicationPort: undefined | number
member

{number} [replicationPort] A value indicating the recovery HTTPS port.

serializedName

serializedName: string = "HyperVReplica2012"

type

type: object

className

className: string = "HyperVReplicaPolicyInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

allowedAuthenticationType

allowedAuthenticationType: object

serializedName

serializedName: string = "allowedAuthenticationType"

type

type: object

name

name: "Number" = "Number"

applicationConsistentSnapshotFrequencyInHours

applicationConsistentSnapshotFrequencyInHours: object

serializedName

serializedName: string = "applicationConsistentSnapshotFrequencyInHours"

type

type: object

name

name: "Number" = "Number"

compression

compression: object

serializedName

serializedName: string = "compression"

type

type: object

name

name: "String" = "String"

initialReplicationMethod

initialReplicationMethod: object

serializedName

serializedName: string = "initialReplicationMethod"

type

type: object

name

name: "String" = "String"

offlineReplicationExportPath

offlineReplicationExportPath: object

serializedName

serializedName: string = "offlineReplicationExportPath"

type

type: object

name

name: "String" = "String"

offlineReplicationImportPath

offlineReplicationImportPath: object

serializedName

serializedName: string = "offlineReplicationImportPath"

type

type: object

name

name: "String" = "String"

onlineReplicationStartTime

onlineReplicationStartTime: object

serializedName

serializedName: string = "onlineReplicationStartTime"

type

type: object

name

name: "String" = "String"

recoveryPoints

recoveryPoints: object

serializedName

serializedName: string = "recoveryPoints"

type

type: object

name

name: "Number" = "Number"

replicaDeletion

replicaDeletion: object

serializedName

serializedName: string = "replicaDeletion"

type

type: object

name

name: "String" = "String"

replicationPort

replicationPort: object

serializedName

serializedName: string = "replicationPort"

type

type: object

name

name: "Number" = "Number"

Const HyperVReplicaReplicationDetails

HyperVReplicaReplicationDetails: object
interface

An interface representing HyperVReplicaReplicationDetails. HyperV replica 2012 replication details.

Optional initialReplicationDetails

initialReplicationDetails: InitialReplicationDetails
member

{InitialReplicationDetails} [initialReplicationDetails] Initial replication details.

instanceType

instanceType: "HyperVReplica2012"
member

{string} instanceType Polymorphic Discriminator

Optional lastReplicatedTime

lastReplicatedTime: Date
member

{Date} [lastReplicatedTime] The Last replication time.

Optional vMDiskDetails

vMDiskDetails: DiskDetails[]
member

{DiskDetails[]} [vMDiskDetails] VM disk details.

Optional vmId

vmId: undefined | string
member

{string} [vmId] The virtual machine Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The PE Network details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

serializedName

serializedName: string = "HyperVReplica2012"

type

type: object

className

className: string = "HyperVReplicaReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

initialReplicationDetails

initialReplicationDetails: object

serializedName

serializedName: string = "initialReplicationDetails"

type

type: object

className

className: string = "InitialReplicationDetails"

name

name: "Composite" = "Composite"

lastReplicatedTime

lastReplicatedTime: object

serializedName

serializedName: string = "lastReplicatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

vMDiskDetails

vMDiskDetails: object

serializedName

serializedName: string = "vMDiskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskDetails"

name

name: "Composite" = "Composite"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

Const HyperVSiteDetails

HyperVSiteDetails: object
interface

An interface representing HyperVSiteDetails. HyperVSite fabric specific details.

instanceType

instanceType: "HyperVSite"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "HyperVSite"

type

type: object

className

className: string = "HyperVSiteDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificDetails"

modelProperties

modelProperties: object

Const HyperVVirtualMachineDetails

HyperVVirtualMachineDetails: object
interface

An interface representing HyperVVirtualMachineDetails. Single Host fabric provider specific VM settings.

Optional diskDetails

diskDetails: DiskDetails[]
member

{DiskDetails[]} [diskDetails] The Last successful failover time.

Optional generation

generation: undefined | string
member

{string} [generation] The id of the object in fabric.

Optional hasFibreChannelAdapter

hasFibreChannelAdapter: PresenceStatus
member

{PresenceStatus} [hasFibreChannelAdapter] A value indicating whether the VM has a fibre channel adapter attached. String value of {SrsDataContract.PresenceStatus} enum. Possible values include: 'Unknown', 'Present', 'NotPresent'

Optional hasPhysicalDisk

hasPhysicalDisk: PresenceStatus
member

{PresenceStatus} [hasPhysicalDisk] A value indicating whether the VM has a physical disk attached. String value of {SrsDataContract.PresenceStatus} enum. Possible values include: 'Unknown', 'Present', 'NotPresent'

Optional hasSharedVhd

hasSharedVhd: PresenceStatus
member

{PresenceStatus} [hasSharedVhd] A value indicating whether the VM has a shared VHD attached. String value of {SrsDataContract.PresenceStatus} enum. Possible values include: 'Unknown', 'Present', 'NotPresent'

instanceType

instanceType: "HyperVVirtualMachine"
member

{string} instanceType Polymorphic Discriminator

Optional osDetails

osDetails: OSDetails
member

{OSDetails} [osDetails] The Last replication time.

Optional sourceItemId

sourceItemId: undefined | string
member

{string} [sourceItemId] The source id of the object.

serializedName

serializedName: string = "HyperVVirtualMachine"

type

type: object

className

className: string = "HyperVVirtualMachineDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ConfigurationSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ConfigurationSettings"

modelProperties

modelProperties: object

diskDetails

diskDetails: object

serializedName

serializedName: string = "diskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskDetails"

name

name: "Composite" = "Composite"

generation

generation: object

serializedName

serializedName: string = "generation"

type

type: object

name

name: "String" = "String"

hasFibreChannelAdapter

hasFibreChannelAdapter: object

serializedName

serializedName: string = "hasFibreChannelAdapter"

type

type: object

name

name: "String" = "String"

hasPhysicalDisk

hasPhysicalDisk: object

serializedName

serializedName: string = "hasPhysicalDisk"

type

type: object

name

name: "String" = "String"

hasSharedVhd

hasSharedVhd: object

serializedName

serializedName: string = "hasSharedVhd"

type

type: object

name

name: "String" = "String"

osDetails

osDetails: object

serializedName

serializedName: string = "osDetails"

type

type: object

className

className: string = "OSDetails"

name

name: "Composite" = "Composite"

sourceItemId

sourceItemId: object

serializedName

serializedName: string = "sourceItemId"

type

type: object

name

name: "String" = "String"

Const IdentityInformation

IdentityInformation: object
interface

An interface representing IdentityInformation. Identity details.

Optional aadAuthority

aadAuthority: undefined | string
member

{string} [aadAuthority] The base authority for Azure Active Directory authentication.

Optional applicationId

applicationId: undefined | string
member

{string} [applicationId] The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.

Optional audience

audience: undefined | string
member

{string} [audience] The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.

Optional certificateThumbprint

certificateThumbprint: undefined | string
member

{string} [certificateThumbprint] The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory.

Optional identityProviderType

identityProviderType: IdentityProviderType
member

{IdentityProviderType} [identityProviderType] The identity provider type. Value is the ToString() of a IdentityProviderType value. Possible values include: 'RecoveryServicesActiveDirectory'

Optional objectId

objectId: undefined | string
member

{string} [objectId] The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.

serializedName

serializedName: string = "IdentityInformation"

type

type: object

className

className: string = "IdentityInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aadAuthority

aadAuthority: object

serializedName

serializedName: string = "aadAuthority"

type

type: object

name

name: "String" = "String"

applicationId

applicationId: object

serializedName

serializedName: string = "applicationId"

type

type: object

name

name: "String" = "String"

audience

audience: object

serializedName

serializedName: string = "audience"

type

type: object

name

name: "String" = "String"

certificateThumbprint

certificateThumbprint: object

serializedName

serializedName: string = "certificateThumbprint"

type

type: object

name

name: "String" = "String"

identityProviderType

identityProviderType: object

serializedName

serializedName: string = "identityProviderType"

type

type: object

name

name: "String" = "String"

objectId

objectId: object

serializedName

serializedName: string = "objectId"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

Const InMageAgentDetails

InMageAgentDetails: object
interface

An interface representing InMageAgentDetails. The details of the InMage agent.

Optional agentExpiryDate

agentExpiryDate: Date
member

{Date} [agentExpiryDate] Agent expiry date.

Optional agentUpdateStatus

agentUpdateStatus: undefined | string
member

{string} [agentUpdateStatus] A value indicating whether installed agent needs to be updated.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The agent version.

Optional postUpdateRebootStatus

postUpdateRebootStatus: undefined | string
member

{string} [postUpdateRebootStatus] A value indicating whether reboot is required after update is applied.

serializedName

serializedName: string = "InMageAgentDetails"

type

type: object

className

className: string = "InMageAgentDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

agentExpiryDate

agentExpiryDate: object

serializedName

serializedName: string = "agentExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

agentUpdateStatus

agentUpdateStatus: object

serializedName

serializedName: string = "agentUpdateStatus"

type

type: object

name

name: "String" = "String"

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

postUpdateRebootStatus

postUpdateRebootStatus: object

serializedName

serializedName: string = "postUpdateRebootStatus"

type

type: object

name

name: "String" = "String"

Const InMageAgentVersionDetails

InMageAgentVersionDetails: object
interface

An interface representing InMageAgentVersionDetails. InMage agent version details.

Optional expiryDate

expiryDate: Date
member

{Date} [expiryDate] Version expiry date.

Optional postUpdateRebootStatus

postUpdateRebootStatus: undefined | string
member

{string} [postUpdateRebootStatus] A value indicating whether reboot is required after update is applied.

Optional status

member

{AgentVersionStatus} [status] A value indicating whether security update required. Possible values include: 'Supported', 'NotSupported', 'Deprecated', 'UpdateRequired', 'SecurityUpdateRequired'

Optional version

version: undefined | string
member

{string} [version] The agent version.

serializedName

serializedName: string = "InMageAgentVersionDetails"

type

type: object

className

className: string = "InMageAgentVersionDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryDate

expiryDate: object

serializedName

serializedName: string = "expiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

postUpdateRebootStatus

postUpdateRebootStatus: object

serializedName

serializedName: string = "postUpdateRebootStatus"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2ApplyRecoveryPointInput

InMageAzureV2ApplyRecoveryPointInput: object
interface

An interface representing InMageAzureV2ApplyRecoveryPointInput. ApplyRecoveryPoint input specific to InMageAzureV2 provider.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional vaultLocation

vaultLocation: undefined | string
member

{string} [vaultLocation] The vault location where the recovery Vm resides.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2ApplyRecoveryPointInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ApplyRecoveryPointProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ApplyRecoveryPointProviderSpecificInput"

modelProperties

modelProperties: object

vaultLocation

vaultLocation: object

serializedName

serializedName: string = "vaultLocation"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2EnableProtectionInput

InMageAzureV2EnableProtectionInput: object
interface

An interface representing InMageAzureV2EnableProtectionInput. VMware Azure specific enable protection input.

Optional disksToInclude

disksToInclude: string[]
member

{string[]} [disksToInclude] The disks to include list.

Optional enableRdpOnTargetOption

enableRdpOnTargetOption: undefined | string
member

{string} [enableRdpOnTargetOption] The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional logStorageAccountId

logStorageAccountId: undefined | string
member

{string} [logStorageAccountId] The storage account to be used for logging during replication.

Optional masterTargetId

masterTargetId: undefined | string
member

{string} [masterTargetId] The Master target Id.

Optional multiVmGroupId

multiVmGroupId: undefined | string
member

{string} [multiVmGroupId] The multi vm group Id.

Optional multiVmGroupName

multiVmGroupName: undefined | string
member

{string} [multiVmGroupName] The multi vm group name.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The Process Server Id.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The CS account Id.

storageAccountId

storageAccountId: string
member

{string} storageAccountId The storage account name.

Optional targetAzureNetworkId

targetAzureNetworkId: undefined | string
member

{string} [targetAzureNetworkId] The selected target Azure network Id.

Optional targetAzureSubnetId

targetAzureSubnetId: undefined | string
member

{string} [targetAzureSubnetId] The selected target Azure subnet Id.

Optional targetAzureV1ResourceGroupId

targetAzureV1ResourceGroupId: undefined | string
member

{string} [targetAzureV1ResourceGroupId] The Id of the target resource group (for classic deployment) in which the failover VM is to be created.

Optional targetAzureV2ResourceGroupId

targetAzureV2ResourceGroupId: undefined | string
member

{string} [targetAzureV2ResourceGroupId] The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.

Optional targetAzureVmName

targetAzureVmName: undefined | string
member

{string} [targetAzureVmName] The target azure Vm Name.

Optional useManagedDisks

useManagedDisks: undefined | string
member

{string} [useManagedDisks] A value indicating whether managed disks should be used during failover.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2EnableProtectionInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EnableProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "EnableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

disksToInclude

disksToInclude: object

serializedName

serializedName: string = "disksToInclude"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

enableRdpOnTargetOption

enableRdpOnTargetOption: object

serializedName

serializedName: string = "enableRdpOnTargetOption"

type

type: object

name

name: "String" = "String"

logStorageAccountId

logStorageAccountId: object

serializedName

serializedName: string = "logStorageAccountId"

type

type: object

name

name: "String" = "String"

masterTargetId

masterTargetId: object

serializedName

serializedName: string = "masterTargetId"

type

type: object

name

name: "String" = "String"

multiVmGroupId

multiVmGroupId: object

serializedName

serializedName: string = "multiVmGroupId"

type

type: object

name

name: "String" = "String"

multiVmGroupName

multiVmGroupName: object

serializedName

serializedName: string = "multiVmGroupName"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

required

required: true = true

serializedName

serializedName: string = "storageAccountId"

type

type: object

name

name: "String" = "String"

targetAzureNetworkId

targetAzureNetworkId: object

serializedName

serializedName: string = "targetAzureNetworkId"

type

type: object

name

name: "String" = "String"

targetAzureSubnetId

targetAzureSubnetId: object

serializedName

serializedName: string = "targetAzureSubnetId"

type

type: object

name

name: "String" = "String"

targetAzureV1ResourceGroupId

targetAzureV1ResourceGroupId: object

serializedName

serializedName: string = "targetAzureV1ResourceGroupId"

type

type: object

name

name: "String" = "String"

targetAzureV2ResourceGroupId

targetAzureV2ResourceGroupId: object

serializedName

serializedName: string = "targetAzureV2ResourceGroupId"

type

type: object

name

name: "String" = "String"

targetAzureVmName

targetAzureVmName: object

serializedName

serializedName: string = "targetAzureVmName"

type

type: object

name

name: "String" = "String"

useManagedDisks

useManagedDisks: object

serializedName

serializedName: string = "useManagedDisks"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2EventDetails

InMageAzureV2EventDetails: object
interface

An interface representing InMageAzureV2EventDetails. Model class for event details of a VMwareAzureV2 event.

Optional category

category: undefined | string
member

{string} [category] InMage Event Category.

Optional component

component: undefined | string
member

{string} [component] InMage Event Component.

Optional correctiveAction

correctiveAction: undefined | string
member

{string} [correctiveAction] Corrective Action string for the event.

Optional details

details: undefined | string
member

{string} [details] InMage Event Details.

Optional eventType

eventType: undefined | string
member

{string} [eventType] InMage Event type. Takes one of the values of {InMageDataContract.InMageMonitoringEventType}.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional siteName

siteName: undefined | string
member

{string} [siteName] VMware Site name.

Optional summary

summary: undefined | string
member

{string} [summary] InMage Event Summary.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2EventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventProviderSpecificDetails"

modelProperties

modelProperties: object

category

category: object

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

component

component: object

serializedName

serializedName: string = "component"

type

type: object

name

name: "String" = "String"

correctiveAction

correctiveAction: object

serializedName

serializedName: string = "correctiveAction"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "String" = "String"

eventType

eventType: object

serializedName

serializedName: string = "eventType"

type

type: object

name

name: "String" = "String"

siteName

siteName: object

serializedName

serializedName: string = "siteName"

type

type: object

name

name: "String" = "String"

summary

summary: object

serializedName

serializedName: string = "summary"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2FailoverProviderInput

InMageAzureV2FailoverProviderInput: object
interface

An interface representing InMageAzureV2FailoverProviderInput. InMageAzureV2 provider specific input for failover.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.

Optional vaultLocation

vaultLocation: undefined | string
member

{string} [vaultLocation] Location of the vault.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2FailoverProviderInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificFailoverInput"

modelProperties

modelProperties: object

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

vaultLocation

vaultLocation: object

serializedName

serializedName: string = "vaultLocation"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2PolicyDetails

InMageAzureV2PolicyDetails: object
interface

An interface representing InMageAzureV2PolicyDetails. InMage Azure v2 specific protection profile details.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency in minutes.

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency in minutes.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmSyncStatus

multiVmSyncStatus: undefined | string
member

{string} [multiVmSyncStatus] A value indicating whether multi-VM sync has to be enabled.

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2PolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const InMageAzureV2PolicyInput

InMageAzureV2PolicyInput: object
interface

An interface representing InMageAzureV2PolicyInput. VMWare Azure specific policy Input.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency (in minutes).

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency (in minutes).

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

multiVmSyncStatus

multiVmSyncStatus: SetMultiVmSyncStatus
member

{SetMultiVmSyncStatus} multiVmSyncStatus A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. Possible values include: 'Enable', 'Disable'

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2PolicyInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

required

required: true = true

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const InMageAzureV2ProtectedDiskDetails

InMageAzureV2ProtectedDiskDetails: object
interface

An interface representing InMageAzureV2ProtectedDiskDetails. InMageAzureV2 protected disk details.

Optional diskCapacityInBytes

diskCapacityInBytes: undefined | number
member

{number} [diskCapacityInBytes] The disk capacity in bytes.

Optional diskId

diskId: undefined | string
member

{string} [diskId] The disk id.

Optional diskName

diskName: undefined | string
member

{string} [diskName] The disk name.

Optional diskResized

diskResized: undefined | string
member

{string} [diskResized] A value indicating whether disk is resized.

Optional fileSystemCapacityInBytes

fileSystemCapacityInBytes: undefined | number
member

{number} [fileSystemCapacityInBytes] The disk file system capacity in bytes.

Optional healthErrorCode

healthErrorCode: undefined | string
member

{string} [healthErrorCode] The health error code for the disk.

Optional lastRpoCalculatedTime

lastRpoCalculatedTime: Date
member

{Date} [lastRpoCalculatedTime] The last RPO calculated time.

Optional protectionStage

protectionStage: undefined | string
member

{string} [protectionStage] The protection stage.

Optional psDataInMegaBytes

psDataInMegaBytes: undefined | number
member

{number} [psDataInMegaBytes] The PS data transit in MB.

Optional resyncDurationInSeconds

resyncDurationInSeconds: undefined | number
member

{number} [resyncDurationInSeconds] The resync duration in seconds.

Optional resyncProgressPercentage

resyncProgressPercentage: undefined | number
member

{number} [resyncProgressPercentage] The resync progress percentage.

Optional resyncRequired

resyncRequired: undefined | string
member

{string} [resyncRequired] A value indicating whether resync is required for this disk.

Optional rpoInSeconds

rpoInSeconds: undefined | number
member

{number} [rpoInSeconds] The RPO in seconds.

Optional sourceDataInMegaBytes

sourceDataInMegaBytes: undefined | number
member

{number} [sourceDataInMegaBytes] The source data transit in MB.

Optional targetDataInMegaBytes

targetDataInMegaBytes: undefined | number
member

{number} [targetDataInMegaBytes] The target data transit in MB.

serializedName

serializedName: string = "InMageAzureV2ProtectedDiskDetails"

type

type: object

className

className: string = "InMageAzureV2ProtectedDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskCapacityInBytes

diskCapacityInBytes: object

serializedName

serializedName: string = "diskCapacityInBytes"

type

type: object

name

name: "Number" = "Number"

diskId

diskId: object

serializedName

serializedName: string = "diskId"

type

type: object

name

name: "String" = "String"

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskResized

diskResized: object

serializedName

serializedName: string = "diskResized"

type

type: object

name

name: "String" = "String"

fileSystemCapacityInBytes

fileSystemCapacityInBytes: object

serializedName

serializedName: string = "fileSystemCapacityInBytes"

type

type: object

name

name: "Number" = "Number"

healthErrorCode

healthErrorCode: object

serializedName

serializedName: string = "healthErrorCode"

type

type: object

name

name: "String" = "String"

lastRpoCalculatedTime

lastRpoCalculatedTime: object

serializedName

serializedName: string = "lastRpoCalculatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

protectionStage

protectionStage: object

serializedName

serializedName: string = "protectionStage"

type

type: object

name

name: "String" = "String"

psDataInMegaBytes

psDataInMegaBytes: object

serializedName

serializedName: string = "psDataInMegaBytes"

type

type: object

name

name: "Number" = "Number"

resyncDurationInSeconds

resyncDurationInSeconds: object

serializedName

serializedName: string = "resyncDurationInSeconds"

type

type: object

name

name: "Number" = "Number"

resyncProgressPercentage

resyncProgressPercentage: object

serializedName

serializedName: string = "resyncProgressPercentage"

type

type: object

name

name: "Number" = "Number"

resyncRequired

resyncRequired: object

serializedName

serializedName: string = "resyncRequired"

type

type: object

name

name: "String" = "String"

rpoInSeconds

rpoInSeconds: object

serializedName

serializedName: string = "rpoInSeconds"

type

type: object

name

name: "Number" = "Number"

sourceDataInMegaBytes

sourceDataInMegaBytes: object

serializedName

serializedName: string = "sourceDataInMegaBytes"

type

type: object

name

name: "Number" = "Number"

targetDataInMegaBytes

targetDataInMegaBytes: object

serializedName

serializedName: string = "targetDataInMegaBytes"

type

type: object

name

name: "Number" = "Number"

Const InMageAzureV2RecoveryPointDetails

InMageAzureV2RecoveryPointDetails: object
interface

An interface representing InMageAzureV2RecoveryPointDetails. InMage Azure V2 provider specific recovery point details.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional isMultiVmSyncPoint

isMultiVmSyncPoint: undefined | string
member

{string} [isMultiVmSyncPoint] A value indicating whether the recovery point is multi VM consistent.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2RecoveryPointDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificRecoveryPointDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificRecoveryPointDetails"

modelProperties

modelProperties: object

isMultiVmSyncPoint

isMultiVmSyncPoint: object

serializedName

serializedName: string = "isMultiVmSyncPoint"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2ReplicationDetails

InMageAzureV2ReplicationDetails: object
interface

An interface representing InMageAzureV2ReplicationDetails. InMageAzureV2 provider specific settings

Optional agentExpiryDate

agentExpiryDate: Date
member

{Date} [agentExpiryDate] Agent expiry date.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The agent version.

Optional azureVMDiskDetails

azureVMDiskDetails: AzureVmDiskDetails[]
member

{AzureVmDiskDetails[]} [azureVMDiskDetails] Azure VM Disk details.

Optional compressedDataRateInMB

compressedDataRateInMB: undefined | number
member

{number} [compressedDataRateInMB] The compressed data change rate in MB.

Optional datastores

datastores: string[]
member

{string[]} [datastores] The datastores of the on-premise machine. Value can be list of strings that contain datastore names.

Optional discoveryType

discoveryType: undefined | string
member

{string} [discoveryType] A value indicating the discovery type of the machine. Value can be vCenter or physical.

Optional diskResized

diskResized: undefined | string
member

{string} [diskResized] A value indicating whether any disk is resized for this VM.

Optional enableRdpOnTargetOption

enableRdpOnTargetOption: undefined | string
member

{string} [enableRdpOnTargetOption] The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.

Optional infrastructureVmId

infrastructureVmId: undefined | string
member

{string} [infrastructureVmId] The infrastructure VM Id.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The source IP address.

Optional isAgentUpdateRequired

isAgentUpdateRequired: undefined | string
member

{string} [isAgentUpdateRequired] A value indicating whether installed agent needs to be updated.

Optional isRebootAfterUpdateRequired

isRebootAfterUpdateRequired: undefined | string
member

{string} [isRebootAfterUpdateRequired] A value indicating whether the source server requires a restart after update.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The last heartbeat received from the source server.

Optional lastRpoCalculatedTime

lastRpoCalculatedTime: Date
member

{Date} [lastRpoCalculatedTime] The last RPO calculated time.

Optional lastUpdateReceivedTime

lastUpdateReceivedTime: Date
member

{Date} [lastUpdateReceivedTime] The last update time received from on-prem components.

Optional licenseType

licenseType: undefined | string
member

{string} [licenseType] License Type of the VM to be used.

Optional masterTargetId

masterTargetId: undefined | string
member

{string} [masterTargetId] The master target Id.

Optional multiVmGroupId

multiVmGroupId: undefined | string
member

{string} [multiVmGroupId] The multi vm group Id.

Optional multiVmGroupName

multiVmGroupName: undefined | string
member

{string} [multiVmGroupName] The multi vm group name.

Optional multiVmSyncStatus

multiVmSyncStatus: undefined | string
member

{string} [multiVmSyncStatus] A value indicating whether multi vm sync is enabled or disabled.

Optional osDiskId

osDiskId: undefined | string
member

{string} [osDiskId] The id of the disk containing the OS.

Optional osType

osType: undefined | string
member

{string} [osType] The type of the OS on the VM.

Optional osVersion

osVersion: undefined | string
member

{string} [osVersion] The OS Version of the protected item.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The process server Id.

Optional protectedDisks

member

{InMageAzureV2ProtectedDiskDetails[]} [protectedDisks] The list of protected disks.

Optional protectionStage

protectionStage: undefined | string
member

{string} [protectionStage] The protection stage.

Optional recoveryAvailabilitySetId

recoveryAvailabilitySetId: undefined | string
member

{string} [recoveryAvailabilitySetId] The recovery availability set Id.

Optional recoveryAzureLogStorageAccountId

recoveryAzureLogStorageAccountId: undefined | string
member

{string} [recoveryAzureLogStorageAccountId] The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.

Optional recoveryAzureResourceGroupId

recoveryAzureResourceGroupId: undefined | string
member

{string} [recoveryAzureResourceGroupId] The target resource group Id.

Optional recoveryAzureStorageAccount

recoveryAzureStorageAccount: undefined | string
member

{string} [recoveryAzureStorageAccount] The recovery Azure storage account.

Optional recoveryAzureVMName

recoveryAzureVMName: undefined | string
member

{string} [recoveryAzureVMName] Recovery Azure given name.

Optional recoveryAzureVMSize

recoveryAzureVMSize: undefined | string
member

{string} [recoveryAzureVMSize] The Recovery Azure VM size.

Optional replicaId

replicaId: undefined | string
member

{string} [replicaId] The replica id of the protected item.

Optional resyncProgressPercentage

resyncProgressPercentage: undefined | number
member

{number} [resyncProgressPercentage] The resync progress percentage.

Optional rpoInSeconds

rpoInSeconds: undefined | number
member

{number} [rpoInSeconds] The RPO in seconds.

Optional selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: undefined | string
member

{string} [selectedRecoveryAzureNetworkId] The selected recovery azure network Id.

Optional selectedSourceNicId

selectedSourceNicId: undefined | string
member

{string} [selectedSourceNicId] The selected source nic Id which will be used as the primary nic during failover.

Optional sourceVmCpuCount

sourceVmCpuCount: undefined | number
member

{number} [sourceVmCpuCount] The CPU count of the VM on the primary side.

Optional sourceVmRamSizeInMB

sourceVmRamSizeInMB: undefined | number
member

{number} [sourceVmRamSizeInMB] The RAM size of the VM on the primary side.

Optional targetVmId

targetVmId: undefined | string
member

{string} [targetVmId] The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM.

Optional uncompressedDataRateInMB

uncompressedDataRateInMB: undefined | number
member

{number} [uncompressedDataRateInMB] The uncompressed data change rate in MB.

Optional useManagedDisks

useManagedDisks: undefined | string
member

{string} [useManagedDisks] A value indicating whether managed disks should be used during failover.

Optional vCenterInfrastructureId

vCenterInfrastructureId: undefined | string
member

{string} [vCenterInfrastructureId] The vCenter infrastructure Id.

Optional validationErrors

validationErrors: HealthError[]
member

{HealthError[]} [validationErrors] The validation errors of the on-premise machine Value can be list of validation errors.

Optional vhdName

vhdName: undefined | string
member

{string} [vhdName] The OS disk VHD name.

Optional vmId

vmId: undefined | string
member

{string} [vmId] The virtual machine Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The PE Network details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2ReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

agentExpiryDate

agentExpiryDate: object

serializedName

serializedName: string = "agentExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

azureVMDiskDetails

azureVMDiskDetails: object

serializedName

serializedName: string = "azureVMDiskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureVmDiskDetails"

name

name: "Composite" = "Composite"

compressedDataRateInMB

compressedDataRateInMB: object

serializedName

serializedName: string = "compressedDataRateInMB"

type

type: object

name

name: "Number" = "Number"

datastores

datastores: object

serializedName

serializedName: string = "datastores"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

discoveryType

discoveryType: object

serializedName

serializedName: string = "discoveryType"

type

type: object

name

name: "String" = "String"

diskResized

diskResized: object

serializedName

serializedName: string = "diskResized"

type

type: object

name

name: "String" = "String"

enableRdpOnTargetOption

enableRdpOnTargetOption: object

serializedName

serializedName: string = "enableRdpOnTargetOption"

type

type: object

name

name: "String" = "String"

infrastructureVmId

infrastructureVmId: object

serializedName

serializedName: string = "infrastructureVmId"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

isAgentUpdateRequired

isAgentUpdateRequired: object

serializedName

serializedName: string = "isAgentUpdateRequired"

type

type: object

name

name: "String" = "String"

isRebootAfterUpdateRequired

isRebootAfterUpdateRequired: object

serializedName

serializedName: string = "isRebootAfterUpdateRequired"

type

type: object

name

name: "String" = "String"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

lastRpoCalculatedTime

lastRpoCalculatedTime: object

serializedName

serializedName: string = "lastRpoCalculatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastUpdateReceivedTime

lastUpdateReceivedTime: object

serializedName

serializedName: string = "lastUpdateReceivedTime"

type

type: object

name

name: "DateTime" = "DateTime"

licenseType

licenseType: object

serializedName

serializedName: string = "licenseType"

type

type: object

name

name: "String" = "String"

masterTargetId

masterTargetId: object

serializedName

serializedName: string = "masterTargetId"

type

type: object

name

name: "String" = "String"

multiVmGroupId

multiVmGroupId: object

serializedName

serializedName: string = "multiVmGroupId"

type

type: object

name

name: "String" = "String"

multiVmGroupName

multiVmGroupName: object

serializedName

serializedName: string = "multiVmGroupName"

type

type: object

name

name: "String" = "String"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

osDiskId

osDiskId: object

serializedName

serializedName: string = "osDiskId"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

osVersion

osVersion: object

serializedName

serializedName: string = "osVersion"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

protectedDisks

protectedDisks: object

serializedName

serializedName: string = "protectedDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InMageAzureV2ProtectedDiskDetails"

name

name: "Composite" = "Composite"

protectionStage

protectionStage: object

serializedName

serializedName: string = "protectionStage"

type

type: object

name

name: "String" = "String"

recoveryAvailabilitySetId

recoveryAvailabilitySetId: object

serializedName

serializedName: string = "recoveryAvailabilitySetId"

type

type: object

name

name: "String" = "String"

recoveryAzureLogStorageAccountId

recoveryAzureLogStorageAccountId: object

serializedName

serializedName: string = "recoveryAzureLogStorageAccountId"

type

type: object

name

name: "String" = "String"

recoveryAzureResourceGroupId

recoveryAzureResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryAzureStorageAccount

recoveryAzureStorageAccount: object

serializedName

serializedName: string = "recoveryAzureStorageAccount"

type

type: object

name

name: "String" = "String"

recoveryAzureVMName

recoveryAzureVMName: object

serializedName

serializedName: string = "recoveryAzureVMName"

type

type: object

name

name: "String" = "String"

recoveryAzureVMSize

recoveryAzureVMSize: object

serializedName

serializedName: string = "recoveryAzureVMSize"

type

type: object

name

name: "String" = "String"

replicaId

replicaId: object

serializedName

serializedName: string = "replicaId"

type

type: object

name

name: "String" = "String"

resyncProgressPercentage

resyncProgressPercentage: object

serializedName

serializedName: string = "resyncProgressPercentage"

type

type: object

name

name: "Number" = "Number"

rpoInSeconds

rpoInSeconds: object

serializedName

serializedName: string = "rpoInSeconds"

type

type: object

name

name: "Number" = "Number"

selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: object

serializedName

serializedName: string = "selectedRecoveryAzureNetworkId"

type

type: object

name

name: "String" = "String"

selectedSourceNicId

selectedSourceNicId: object

serializedName

serializedName: string = "selectedSourceNicId"

type

type: object

name

name: "String" = "String"

sourceVmCpuCount

sourceVmCpuCount: object

serializedName

serializedName: string = "sourceVmCpuCount"

type

type: object

name

name: "Number" = "Number"

sourceVmRamSizeInMB

sourceVmRamSizeInMB: object

serializedName

serializedName: string = "sourceVmRamSizeInMB"

type

type: object

name

name: "Number" = "Number"

targetVmId

targetVmId: object

serializedName

serializedName: string = "targetVmId"

type

type: object

name

name: "String" = "String"

uncompressedDataRateInMB

uncompressedDataRateInMB: object

serializedName

serializedName: string = "uncompressedDataRateInMB"

type

type: object

name

name: "Number" = "Number"

useManagedDisks

useManagedDisks: object

serializedName

serializedName: string = "useManagedDisks"

type

type: object

name

name: "String" = "String"

vCenterInfrastructureId

vCenterInfrastructureId: object

serializedName

serializedName: string = "vCenterInfrastructureId"

type

type: object

name

name: "String" = "String"

validationErrors

validationErrors: object

serializedName

serializedName: string = "validationErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

vhdName

vhdName: object

serializedName

serializedName: string = "vhdName"

type

type: object

name

name: "String" = "String"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2ReprotectInput

InMageAzureV2ReprotectInput: object
interface

An interface representing InMageAzureV2ReprotectInput. InMageAzureV2 specific provider input.

Optional disksToInclude

disksToInclude: string[]
member

{string[]} [disksToInclude] The disks to include list.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional logStorageAccountId

logStorageAccountId: undefined | string
member

{string} [logStorageAccountId] The storage account to be used for logging during replication.

Optional masterTargetId

masterTargetId: undefined | string
member

{string} [masterTargetId] The Master target Id.

Optional policyId

policyId: undefined | string
member

{string} [policyId] The Policy Id.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The Process Server Id.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The CS account Id.

Optional storageAccountId

storageAccountId: undefined | string
member

{string} [storageAccountId] The storage account id.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2ReprotectInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReverseReplicationProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReverseReplicationProviderSpecificInput"

modelProperties

modelProperties: object

disksToInclude

disksToInclude: object

serializedName

serializedName: string = "disksToInclude"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

logStorageAccountId

logStorageAccountId: object

serializedName

serializedName: string = "logStorageAccountId"

type

type: object

name

name: "String" = "String"

masterTargetId

masterTargetId: object

serializedName

serializedName: string = "masterTargetId"

type

type: object

name

name: "String" = "String"

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "storageAccountId"

type

type: object

name

name: "String" = "String"

Const InMageAzureV2UpdateReplicationProtectedItemInput

InMageAzureV2UpdateReplicationProtectedItemInput: object
interface

An interface representing InMageAzureV2UpdateReplicationProtectedItemInput. InMage Azure V2 input to update replication protected item.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryAzureV1ResourceGroupId

recoveryAzureV1ResourceGroupId: undefined | string
member

{string} [recoveryAzureV1ResourceGroupId] The recovery Azure resource group Id for classic deployment.

Optional recoveryAzureV2ResourceGroupId

recoveryAzureV2ResourceGroupId: undefined | string
member

{string} [recoveryAzureV2ResourceGroupId] The recovery Azure resource group Id for resource manager deployment.

Optional useManagedDisks

useManagedDisks: undefined | string
member

{string} [useManagedDisks] A value indicating whether managed disks should be used during failover.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "InMageAzureV2UpdateReplicationProtectedItemInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = UpdateReplicationProtectedItemProviderInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "UpdateReplicationProtectedItemProviderInput"

modelProperties

modelProperties: object

recoveryAzureV1ResourceGroupId

recoveryAzureV1ResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureV1ResourceGroupId"

type

type: object

name

name: "String" = "String"

recoveryAzureV2ResourceGroupId

recoveryAzureV2ResourceGroupId: object

serializedName

serializedName: string = "recoveryAzureV2ResourceGroupId"

type

type: object

name

name: "String" = "String"

useManagedDisks

useManagedDisks: object

serializedName

serializedName: string = "useManagedDisks"

type

type: object

name

name: "String" = "String"

Const InMageBasePolicyDetails

InMageBasePolicyDetails: object
interface

An interface representing InMageBasePolicyDetails. Base class for the policies of providers using InMage replication.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency in minutes.

instanceType

instanceType: "InMageBasePolicyDetails"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmSyncStatus

multiVmSyncStatus: undefined | string
member

{string} [multiVmSyncStatus] A value indicating whether multi-VM sync has to be enabled.

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "InMageBasePolicyDetails"

type

type: object

className

className: string = "InMageBasePolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const InMageDisableProtectionProviderSpecificInput

InMageDisableProtectionProviderSpecificInput: object
interface

An interface representing InMageDisableProtectionProviderSpecificInput. InMage disable protection provider specific input.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

Optional replicaVmDeletionStatus

replicaVmDeletionStatus: undefined | string
member

{string} [replicaVmDeletionStatus] A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain.

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMageDisableProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DisableProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "DisableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

replicaVmDeletionStatus

replicaVmDeletionStatus: object

serializedName

serializedName: string = "replicaVmDeletionStatus"

type

type: object

name

name: "String" = "String"

Const InMageDiskDetails

InMageDiskDetails: object
interface

An interface representing InMageDiskDetails. VMware/Physical specific Disk Details

Optional diskConfiguration

diskConfiguration: undefined | string
member

{string} [diskConfiguration] Whether disk is dynamic disk or basic disk.

Optional diskId

diskId: undefined | string
member

{string} [diskId] The disk Id.

Optional diskName

diskName: undefined | string
member

{string} [diskName] The disk name.

Optional diskSizeInMB

diskSizeInMB: undefined | string
member

{string} [diskSizeInMB] The disk size in MB.

Optional diskType

diskType: undefined | string
member

{string} [diskType] Whether disk is system disk or data disk.

Optional volumeList

volumeList: DiskVolumeDetails[]
member

{DiskVolumeDetails[]} [volumeList] Volumes of the disk.

serializedName

serializedName: string = "InMageDiskDetails"

type

type: object

className

className: string = "InMageDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskConfiguration

diskConfiguration: object

serializedName

serializedName: string = "diskConfiguration"

type

type: object

name

name: "String" = "String"

diskId

diskId: object

serializedName

serializedName: string = "diskId"

type

type: object

name

name: "String" = "String"

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskSizeInMB

diskSizeInMB: object

serializedName

serializedName: string = "diskSizeInMB"

type

type: object

name

name: "String" = "String"

diskType

diskType: object

serializedName

serializedName: string = "diskType"

type

type: object

name

name: "String" = "String"

volumeList

volumeList: object

serializedName

serializedName: string = "volumeList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskVolumeDetails"

name

name: "Composite" = "Composite"

Const InMageDiskExclusionInput

InMageDiskExclusionInput: object
interface

An interface representing InMageDiskExclusionInput. DiskExclusionInput when doing enable protection of virtual machine in InMage provider.

Optional diskSignatureOptions

diskSignatureOptions: InMageDiskSignatureExclusionOptions[]
member

{InMageDiskSignatureExclusionOptions[]} [diskSignatureOptions] The guest disk signature based option for disk exclusion.

Optional volumeOptions

member

{InMageVolumeExclusionOptions[]} [volumeOptions] The volume label based option for disk exclusion.

serializedName

serializedName: string = "InMageDiskExclusionInput"

type

type: object

className

className: string = "InMageDiskExclusionInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskSignatureOptions

diskSignatureOptions: object

serializedName

serializedName: string = "diskSignatureOptions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InMageDiskSignatureExclusionOptions"

name

name: "Composite" = "Composite"

volumeOptions

volumeOptions: object

serializedName

serializedName: string = "volumeOptions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InMageVolumeExclusionOptions"

name

name: "Composite" = "Composite"

Const InMageDiskSignatureExclusionOptions

InMageDiskSignatureExclusionOptions: object
interface

An interface representing InMageDiskSignatureExclusionOptions. Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.

Optional diskSignature

diskSignature: undefined | string
member

{string} [diskSignature] The guest signature of disk to be excluded from replication.

serializedName

serializedName: string = "InMageDiskSignatureExclusionOptions"

type

type: object

className

className: string = "InMageDiskSignatureExclusionOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskSignature

diskSignature: object

serializedName

serializedName: string = "diskSignature"

type

type: object

name

name: "String" = "String"

Const InMageEnableProtectionInput

InMageEnableProtectionInput: object
interface

An interface representing InMageEnableProtectionInput. VMware Azure specific enable protection input.

Optional datastoreName

datastoreName: undefined | string
member

{string} [datastoreName] The target datastore name.

Optional diskExclusionInput

diskExclusionInput: InMageDiskExclusionInput
member

{InMageDiskExclusionInput} [diskExclusionInput] The enable disk exclusion input.

Optional disksToInclude

disksToInclude: string[]
member

{string[]} [disksToInclude] The disks to include list.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

masterTargetId

masterTargetId: string
member

{string} masterTargetId The Master Target Id.

multiVmGroupId

multiVmGroupId: string
member

{string} multiVmGroupId The multi vm group Id.

multiVmGroupName

multiVmGroupName: string
member

{string} multiVmGroupName The multi vm group name.

processServerId

processServerId: string
member

{string} processServerId The Process Server Id.

retentionDrive

retentionDrive: string
member

{string} retentionDrive The retention drive to use on the MT.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The CS account Id.

Optional vmFriendlyName

vmFriendlyName: undefined | string
member

{string} [vmFriendlyName] The Vm Name.

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMageEnableProtectionInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EnableProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "EnableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

datastoreName

datastoreName: object

serializedName

serializedName: string = "datastoreName"

type

type: object

name

name: "String" = "String"

diskExclusionInput

diskExclusionInput: object

serializedName

serializedName: string = "diskExclusionInput"

type

type: object

className

className: string = "InMageDiskExclusionInput"

name

name: "Composite" = "Composite"

disksToInclude

disksToInclude: object

serializedName

serializedName: string = "disksToInclude"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

masterTargetId

masterTargetId: object

required

required: true = true

serializedName

serializedName: string = "masterTargetId"

type

type: object

name

name: "String" = "String"

multiVmGroupId

multiVmGroupId: object

required

required: true = true

serializedName

serializedName: string = "multiVmGroupId"

type

type: object

name

name: "String" = "String"

multiVmGroupName

multiVmGroupName: object

required

required: true = true

serializedName

serializedName: string = "multiVmGroupName"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

required

required: true = true

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

retentionDrive

retentionDrive: object

required

required: true = true

serializedName

serializedName: string = "retentionDrive"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

vmFriendlyName

vmFriendlyName: object

serializedName

serializedName: string = "vmFriendlyName"

type

type: object

name

name: "String" = "String"

Const InMageFailoverProviderInput

InMageFailoverProviderInput: object
interface

An interface representing InMageFailoverProviderInput. Provider specific input for InMage failover.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.

Optional recoveryPointType

recoveryPointType: RecoveryPointType
member

{RecoveryPointType} [recoveryPointType] The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored. Possible values include: 'LatestTime', 'LatestTag', 'Custom'

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMageFailoverProviderInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProviderSpecificFailoverInput"

modelProperties

modelProperties: object

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

recoveryPointType

recoveryPointType: object

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

Const InMagePolicyDetails

InMagePolicyDetails: object
interface

An interface representing InMagePolicyDetails. InMage specific protection profile details.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency in minutes.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmSyncStatus

multiVmSyncStatus: undefined | string
member

{string} [multiVmSyncStatus] A value indicating whether multi-VM sync has to be enabled.

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMagePolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const InMagePolicyInput

InMagePolicyInput: object
interface

An interface representing InMagePolicyInput. VMWare Azure specific protection profile Input.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency (in minutes).

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

multiVmSyncStatus

multiVmSyncStatus: SetMultiVmSyncStatus
member

{SetMultiVmSyncStatus} multiVmSyncStatus A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. Possible values include: 'Enable', 'Disable'

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMagePolicyInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

required

required: true = true

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const InMageProtectedDiskDetails

InMageProtectedDiskDetails: object
interface

An interface representing InMageProtectedDiskDetails. InMage protected disk details.

Optional diskCapacityInBytes

diskCapacityInBytes: undefined | number
member

{number} [diskCapacityInBytes] The disk capacity in bytes.

Optional diskId

diskId: undefined | string
member

{string} [diskId] The disk id.

Optional diskName

diskName: undefined | string
member

{string} [diskName] The disk name.

Optional diskResized

diskResized: undefined | string
member

{string} [diskResized] A value indicating whether disk is resized.

Optional fileSystemCapacityInBytes

fileSystemCapacityInBytes: undefined | number
member

{number} [fileSystemCapacityInBytes] The file system capacity in bytes.

Optional healthErrorCode

healthErrorCode: undefined | string
member

{string} [healthErrorCode] The health error code for the disk.

Optional lastRpoCalculatedTime

lastRpoCalculatedTime: Date
member

{Date} [lastRpoCalculatedTime] The last RPO calculated time.

Optional protectionStage

protectionStage: undefined | string
member

{string} [protectionStage] The protection stage.

Optional psDataInMB

psDataInMB: undefined | number
member

{number} [psDataInMB] The PS data transit in MB.

Optional resyncDurationInSeconds

resyncDurationInSeconds: undefined | number
member

{number} [resyncDurationInSeconds] The resync duration in seconds.

Optional resyncProgressPercentage

resyncProgressPercentage: undefined | number
member

{number} [resyncProgressPercentage] The resync progress percentage.

Optional resyncRequired

resyncRequired: undefined | string
member

{string} [resyncRequired] A value indicating whether resync is required for this disk.

Optional rpoInSeconds

rpoInSeconds: undefined | number
member

{number} [rpoInSeconds] The RPO in seconds.

Optional sourceDataInMB

sourceDataInMB: undefined | number
member

{number} [sourceDataInMB] The source data transit in MB.

Optional targetDataInMB

targetDataInMB: undefined | number
member

{number} [targetDataInMB] The target data transit in MB.

serializedName

serializedName: string = "InMageProtectedDiskDetails"

type

type: object

className

className: string = "InMageProtectedDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskCapacityInBytes

diskCapacityInBytes: object

serializedName

serializedName: string = "diskCapacityInBytes"

type

type: object

name

name: "Number" = "Number"

diskId

diskId: object

serializedName

serializedName: string = "diskId"

type

type: object

name

name: "String" = "String"

diskName

diskName: object

serializedName

serializedName: string = "diskName"

type

type: object

name

name: "String" = "String"

diskResized

diskResized: object

serializedName

serializedName: string = "diskResized"

type

type: object

name

name: "String" = "String"

fileSystemCapacityInBytes

fileSystemCapacityInBytes: object

serializedName

serializedName: string = "fileSystemCapacityInBytes"

type

type: object

name

name: "Number" = "Number"

healthErrorCode

healthErrorCode: object

serializedName

serializedName: string = "healthErrorCode"

type

type: object

name

name: "String" = "String"

lastRpoCalculatedTime

lastRpoCalculatedTime: object

serializedName

serializedName: string = "lastRpoCalculatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

protectionStage

protectionStage: object

serializedName

serializedName: string = "protectionStage"

type

type: object

name

name: "String" = "String"

psDataInMB

psDataInMB: object

serializedName

serializedName: string = "psDataInMB"

type

type: object

name

name: "Number" = "Number"

resyncDurationInSeconds

resyncDurationInSeconds: object

serializedName

serializedName: string = "resyncDurationInSeconds"

type

type: object

name

name: "Number" = "Number"

resyncProgressPercentage

resyncProgressPercentage: object

serializedName

serializedName: string = "resyncProgressPercentage"

type

type: object

name

name: "Number" = "Number"

resyncRequired

resyncRequired: object

serializedName

serializedName: string = "resyncRequired"

type

type: object

name

name: "String" = "String"

rpoInSeconds

rpoInSeconds: object

serializedName

serializedName: string = "rpoInSeconds"

type

type: object

name

name: "Number" = "Number"

sourceDataInMB

sourceDataInMB: object

serializedName

serializedName: string = "sourceDataInMB"

type

type: object

name

name: "Number" = "Number"

targetDataInMB

targetDataInMB: object

serializedName

serializedName: string = "targetDataInMB"

type

type: object

name

name: "Number" = "Number"

Const InMageReplicationDetails

InMageReplicationDetails: object
interface

An interface representing InMageReplicationDetails. InMage provider specific settings

Optional activeSiteType

activeSiteType: undefined | string
member

{string} [activeSiteType] The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.

Optional agentDetails

agentDetails: InMageAgentDetails
member

{InMageAgentDetails} [agentDetails] The agent details.

Optional azureStorageAccountId

azureStorageAccountId: undefined | string
member

{string} [azureStorageAccountId] A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null.

Optional compressedDataRateInMB

compressedDataRateInMB: undefined | number
member

{number} [compressedDataRateInMB] The compressed data change rate in MB.

Optional consistencyPoints

consistencyPoints: object | object
member

{{ [propertyName: string]: Date } | { [propertyName: string]: string }} [consistencyPoints] The collection of Consistency points.

Optional datastores

datastores: string[]
member

{string[]} [datastores] The datastores of the on-premise machine Value can be list of strings that contain datastore names

Optional discoveryType

discoveryType: undefined | string
member

{string} [discoveryType] A value indicating the discovery type of the machine.

Optional diskResized

diskResized: undefined | string
member

{string} [diskResized] A value indicating whether any disk is resized for this VM.

Optional infrastructureVmId

infrastructureVmId: undefined | string
member

{string} [infrastructureVmId] The infrastructure VM Id.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The source IP address.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The last heartbeat received from the source server.

Optional lastRpoCalculatedTime

lastRpoCalculatedTime: Date
member

{Date} [lastRpoCalculatedTime] The last RPO calculated time.

Optional lastUpdateReceivedTime

lastUpdateReceivedTime: Date
member

{Date} [lastUpdateReceivedTime] The last update time received from on-prem components.

Optional masterTargetId

masterTargetId: undefined | string
member

{string} [masterTargetId] The master target Id.

Optional multiVmGroupId

multiVmGroupId: undefined | string
member

{string} [multiVmGroupId] The multi vm group Id, if any.

Optional multiVmGroupName

multiVmGroupName: undefined | string
member

{string} [multiVmGroupName] The multi vm group name, if any.

Optional multiVmSyncStatus

multiVmSyncStatus: undefined | string
member

{string} [multiVmSyncStatus] A value indicating whether the multi vm sync is enabled or disabled.

Optional osDetails

osDetails: OSDiskDetails
member

{OSDiskDetails} [osDetails] The OS details.

Optional osVersion

osVersion: undefined | string
member

{string} [osVersion] The OS Version of the protected item.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The process server Id.

Optional protectedDisks

protectedDisks: InMageProtectedDiskDetails[]
member

{InMageProtectedDiskDetails[]} [protectedDisks] The list of protected disks.

Optional protectionStage

protectionStage: undefined | string
member

{string} [protectionStage] The protection stage.

Optional rebootAfterUpdateStatus

rebootAfterUpdateStatus: undefined | string
member

{string} [rebootAfterUpdateStatus] A value indicating whether the source server requires a restart after update.

Optional replicaId

replicaId: undefined | string
member

{string} [replicaId] The replica id of the protected item.

Optional resyncDetails

member

{InitialReplicationDetails} [resyncDetails] The resync details of the machine

Optional retentionWindowEnd

retentionWindowEnd: Date
member

{Date} [retentionWindowEnd] The retention window end time.

Optional retentionWindowStart

retentionWindowStart: Date
member

{Date} [retentionWindowStart] The retention window start time.

Optional rpoInSeconds

rpoInSeconds: undefined | number
member

{number} [rpoInSeconds] The RPO in seconds.

Optional sourceVmCpuCount

sourceVmCpuCount: undefined | number
member

{number} [sourceVmCpuCount] The CPU count of the VM on the primary side.

Optional sourceVmRamSizeInMB

sourceVmRamSizeInMB: undefined | number
member

{number} [sourceVmRamSizeInMB] The RAM size of the VM on the primary side.

Optional uncompressedDataRateInMB

uncompressedDataRateInMB: undefined | number
member

{number} [uncompressedDataRateInMB] The uncompressed data change rate in MB.

Optional vCenterInfrastructureId

vCenterInfrastructureId: undefined | string
member

{string} [vCenterInfrastructureId] The vCenter infrastructure Id.

Optional validationErrors

validationErrors: HealthError[]
member

{HealthError[]} [validationErrors] The validation errors of the on-premise machine Value can be list of validation errors

Optional vmId

vmId: undefined | string
member

{string} [vmId] The virtual machine Id.

Optional vmNics

vmNics: VMNicDetails[]
member

{VMNicDetails[]} [vmNics] The PE Network details.

Optional vmProtectionState

vmProtectionState: undefined | string
member

{string} [vmProtectionState] The protection state for the vm.

Optional vmProtectionStateDescription

vmProtectionStateDescription: undefined | string
member

{string} [vmProtectionStateDescription] The protection state description for the vm.

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMageReplicationDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReplicationProviderSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

activeSiteType

activeSiteType: object

serializedName

serializedName: string = "activeSiteType"

type

type: object

name

name: "String" = "String"

agentDetails

agentDetails: object

serializedName

serializedName: string = "agentDetails"

type

type: object

className

className: string = "InMageAgentDetails"

name

name: "Composite" = "Composite"

azureStorageAccountId

azureStorageAccountId: object

serializedName

serializedName: string = "azureStorageAccountId"

type

type: object

name

name: "String" = "String"

compressedDataRateInMB

compressedDataRateInMB: object

serializedName

serializedName: string = "compressedDataRateInMB"

type

type: object

name

name: "Number" = "Number"

consistencyPoints

consistencyPoints: object

serializedName

serializedName: string = "consistencyPoints"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "DateTime" = "DateTime"

datastores

datastores: object

serializedName

serializedName: string = "datastores"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

discoveryType

discoveryType: object

serializedName

serializedName: string = "discoveryType"

type

type: object

name

name: "String" = "String"

diskResized

diskResized: object

serializedName

serializedName: string = "diskResized"

type

type: object

name

name: "String" = "String"

infrastructureVmId

infrastructureVmId: object

serializedName

serializedName: string = "infrastructureVmId"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

lastRpoCalculatedTime

lastRpoCalculatedTime: object

serializedName

serializedName: string = "lastRpoCalculatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastUpdateReceivedTime

lastUpdateReceivedTime: object

serializedName

serializedName: string = "lastUpdateReceivedTime"

type

type: object

name

name: "DateTime" = "DateTime"

masterTargetId

masterTargetId: object

serializedName

serializedName: string = "masterTargetId"

type

type: object

name

name: "String" = "String"

multiVmGroupId

multiVmGroupId: object

serializedName

serializedName: string = "multiVmGroupId"

type

type: object

name

name: "String" = "String"

multiVmGroupName

multiVmGroupName: object

serializedName

serializedName: string = "multiVmGroupName"

type

type: object

name

name: "String" = "String"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

osDetails

osDetails: object

serializedName

serializedName: string = "osDetails"

type

type: object

className

className: string = "OSDiskDetails"

name

name: "Composite" = "Composite"

osVersion

osVersion: object

serializedName

serializedName: string = "osVersion"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

protectedDisks

protectedDisks: object

serializedName

serializedName: string = "protectedDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InMageProtectedDiskDetails"

name

name: "Composite" = "Composite"

protectionStage

protectionStage: object

serializedName

serializedName: string = "protectionStage"

type

type: object

name

name: "String" = "String"

rebootAfterUpdateStatus

rebootAfterUpdateStatus: object

serializedName

serializedName: string = "rebootAfterUpdateStatus"

type

type: object

name

name: "String" = "String"

replicaId

replicaId: object

serializedName

serializedName: string = "replicaId"

type

type: object

name

name: "String" = "String"

resyncDetails

resyncDetails: object

serializedName

serializedName: string = "resyncDetails"

type

type: object

className

className: string = "InitialReplicationDetails"

name

name: "Composite" = "Composite"

retentionWindowEnd

retentionWindowEnd: object

serializedName

serializedName: string = "retentionWindowEnd"

type

type: object

name

name: "DateTime" = "DateTime"

retentionWindowStart

retentionWindowStart: object

serializedName

serializedName: string = "retentionWindowStart"

type

type: object

name

name: "DateTime" = "DateTime"

rpoInSeconds

rpoInSeconds: object

serializedName

serializedName: string = "rpoInSeconds"

type

type: object

name

name: "Number" = "Number"

sourceVmCpuCount

sourceVmCpuCount: object

serializedName

serializedName: string = "sourceVmCpuCount"

type

type: object

name

name: "Number" = "Number"

sourceVmRamSizeInMB

sourceVmRamSizeInMB: object

serializedName

serializedName: string = "sourceVmRamSizeInMB"

type

type: object

name

name: "Number" = "Number"

uncompressedDataRateInMB

uncompressedDataRateInMB: object

serializedName

serializedName: string = "uncompressedDataRateInMB"

type

type: object

name

name: "Number" = "Number"

vCenterInfrastructureId

vCenterInfrastructureId: object

serializedName

serializedName: string = "vCenterInfrastructureId"

type

type: object

name

name: "String" = "String"

validationErrors

validationErrors: object

serializedName

serializedName: string = "validationErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

vmProtectionState

vmProtectionState: object

serializedName

serializedName: string = "vmProtectionState"

type

type: object

name

name: "String" = "String"

vmProtectionStateDescription

vmProtectionStateDescription: object

serializedName

serializedName: string = "vmProtectionStateDescription"

type

type: object

name

name: "String" = "String"

Const InMageReprotectInput

InMageReprotectInput: object
interface

An interface representing InMageReprotectInput. InMageAzureV2 specific provider input.

Optional datastoreName

datastoreName: undefined | string
member

{string} [datastoreName] The target datastore name.

Optional diskExclusionInput

diskExclusionInput: InMageDiskExclusionInput
member

{InMageDiskExclusionInput} [diskExclusionInput] The enable disk exclusion input.

Optional disksToInclude

disksToInclude: string[]
member

{string[]} [disksToInclude] The disks to include list.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

masterTargetId

masterTargetId: string
member

{string} masterTargetId The Master Target Id.

processServerId

processServerId: string
member

{string} processServerId The Process Server Id.

profileId

profileId: string
member

{string} profileId The Policy Id.

retentionDrive

retentionDrive: string
member

{string} retentionDrive The retention drive to use on the MT.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The CS account Id.

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "InMageReprotectInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ReverseReplicationProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "ReverseReplicationProviderSpecificInput"

modelProperties

modelProperties: object

datastoreName

datastoreName: object

serializedName

serializedName: string = "datastoreName"

type

type: object

name

name: "String" = "String"

diskExclusionInput

diskExclusionInput: object

serializedName

serializedName: string = "diskExclusionInput"

type

type: object

className

className: string = "InMageDiskExclusionInput"

name

name: "Composite" = "Composite"

disksToInclude

disksToInclude: object

serializedName

serializedName: string = "disksToInclude"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

masterTargetId

masterTargetId: object

required

required: true = true

serializedName

serializedName: string = "masterTargetId"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

required

required: true = true

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

profileId

profileId: object

required

required: true = true

serializedName

serializedName: string = "profileId"

type

type: object

name

name: "String" = "String"

retentionDrive

retentionDrive: object

required

required: true = true

serializedName

serializedName: string = "retentionDrive"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

Const InMageVolumeExclusionOptions

InMageVolumeExclusionOptions: object
interface

An interface representing InMageVolumeExclusionOptions. Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.

Optional onlyExcludeIfSingleVolume

onlyExcludeIfSingleVolume: undefined | string
member

{string} [onlyExcludeIfSingleVolume] The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.

Optional volumeLabel

volumeLabel: undefined | string
member

{string} [volumeLabel] The volume label. The disk having any volume with this label will be excluded from replication.

serializedName

serializedName: string = "InMageVolumeExclusionOptions"

type

type: object

className

className: string = "InMageVolumeExclusionOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

onlyExcludeIfSingleVolume

onlyExcludeIfSingleVolume: object

serializedName

serializedName: string = "onlyExcludeIfSingleVolume"

type

type: object

name

name: "String" = "String"

volumeLabel

volumeLabel: object

serializedName

serializedName: string = "volumeLabel"

type

type: object

name

name: "String" = "String"

Const InconsistentVmDetails

InconsistentVmDetails: object
interface

An interface representing InconsistentVmDetails. This class stores the monitoring details for consistency check of inconsistent Protected Entity.

Optional cloudName

cloudName: undefined | string
member

{string} [cloudName] The Cloud name.

Optional details

details: string[]
member

{string[]} [details] The list of details regarding state of the Protected Entity in SRS and On prem.

Optional errorIds

errorIds: string[]
member

{string[]} [errorIds] The list of error ids.

Optional vmName

vmName: undefined | string
member

{string} [vmName] The Vm name.

serializedName

serializedName: string = "InconsistentVmDetails"

type

type: object

className

className: string = "InconsistentVmDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cloudName

cloudName: object

serializedName

serializedName: string = "cloudName"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

errorIds

errorIds: object

serializedName

serializedName: string = "errorIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

vmName

vmName: object

serializedName

serializedName: string = "vmName"

type

type: object

name

name: "String" = "String"

Const InitialReplicationDetails

InitialReplicationDetails: object
interface

An interface representing InitialReplicationDetails. Initial replication details.

Optional initialReplicationProgressPercentage

initialReplicationProgressPercentage: undefined | string
member

{string} [initialReplicationProgressPercentage] The initial replication progress percentage.

Optional initialReplicationType

initialReplicationType: undefined | string
member

{string} [initialReplicationType] Initial replication type.

serializedName

serializedName: string = "InitialReplicationDetails"

type

type: object

className

className: string = "InitialReplicationDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

initialReplicationProgressPercentage

initialReplicationProgressPercentage: object

serializedName

serializedName: string = "initialReplicationProgressPercentage"

type

type: object

name

name: "String" = "String"

initialReplicationType

initialReplicationType: object

serializedName

serializedName: string = "initialReplicationType"

type

type: object

name

name: "String" = "String"

Const InlineWorkflowTaskDetails

InlineWorkflowTaskDetails: object
interface

An interface representing InlineWorkflowTaskDetails. This class represents the inline workflow task details.

Optional childTasks

childTasks: ASRTask[]
member

{ASRTask[]} [childTasks] The child tasks.

instanceType

instanceType: "InlineWorkflowTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional workflowIds

workflowIds: string[]
member

{string[]} [workflowIds] The list of child workflow ids.

serializedName

serializedName: string = "InlineWorkflowTaskDetails"

type

type: object

className

className: string = "InlineWorkflowTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = GroupTaskDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "GroupTaskDetails"

modelProperties

modelProperties: object

workflowIds

workflowIds: object

serializedName

serializedName: string = "workflowIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const InnerHealthError

InnerHealthError: object
interface

An interface representing InnerHealthError. Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.

Optional creationTimeUtc

creationTimeUtc: Date
member

{Date} [creationTimeUtc] Error creation time (UTC)

Optional entityId

entityId: undefined | string
member

{string} [entityId] ID of the entity.

Optional errorCategory

errorCategory: undefined | string
member

{string} [errorCategory] Category of error.

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] Error code.

Optional errorLevel

errorLevel: undefined | string
member

{string} [errorLevel] Level of error.

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] Error message.

Optional errorSource

errorSource: undefined | string
member

{string} [errorSource] Source of error.

Optional errorType

errorType: undefined | string
member

{string} [errorType] Type of error.

Optional possibleCauses

possibleCauses: undefined | string
member

{string} [possibleCauses] Possible causes of error.

Optional recommendedAction

recommendedAction: undefined | string
member

{string} [recommendedAction] Recommended action to resolve error.

Optional recoveryProviderErrorMessage

recoveryProviderErrorMessage: undefined | string
member

{string} [recoveryProviderErrorMessage] DRA error message.

Optional summaryMessage

summaryMessage: undefined | string
member

{string} [summaryMessage] Summary message of the entity.

serializedName

serializedName: string = "InnerHealthError"

type

type: object

className

className: string = "InnerHealthError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTimeUtc

creationTimeUtc: object

serializedName

serializedName: string = "creationTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

entityId

entityId: object

serializedName

serializedName: string = "entityId"

type

type: object

name

name: "String" = "String"

errorCategory

errorCategory: object

serializedName

serializedName: string = "errorCategory"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

errorLevel

errorLevel: object

serializedName

serializedName: string = "errorLevel"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

errorSource

errorSource: object

serializedName

serializedName: string = "errorSource"

type

type: object

name

name: "String" = "String"

errorType

errorType: object

serializedName

serializedName: string = "errorType"

type

type: object

name

name: "String" = "String"

possibleCauses

possibleCauses: object

serializedName

serializedName: string = "possibleCauses"

type

type: object

name

name: "String" = "String"

recommendedAction

recommendedAction: object

serializedName

serializedName: string = "recommendedAction"

type

type: object

name

name: "String" = "String"

recoveryProviderErrorMessage

recoveryProviderErrorMessage: object

serializedName

serializedName: string = "recoveryProviderErrorMessage"

type

type: object

name

name: "String" = "String"

summaryMessage

summaryMessage: object

serializedName

serializedName: string = "summaryMessage"

type

type: object

name

name: "String" = "String"

Const InputEndpoint

InputEndpoint: object
interface

An interface representing InputEndpoint. Azure VM input endpoint details.

Optional endpointName

endpointName: undefined | string
member

{string} [endpointName] The input endpoint name.

Optional privatePort

privatePort: undefined | number
member

{number} [privatePort] The input endpoint private port.

Optional protocol

protocol: undefined | string
member

{string} [protocol] The input endpoint protocol.

Optional publicPort

publicPort: undefined | number
member

{number} [publicPort] The input endpoint public port.

serializedName

serializedName: string = "InputEndpoint"

type

type: object

className

className: string = "InputEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endpointName

endpointName: object

serializedName

serializedName: string = "endpointName"

type

type: object

name

name: "String" = "String"

privatePort

privatePort: object

serializedName

serializedName: string = "privatePort"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

publicPort

publicPort: object

serializedName

serializedName: string = "publicPort"

type

type: object

name

name: "Number" = "Number"

Const Job

Job: object
interface

An interface representing Job. Job details.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: JobProperties
member

{JobProperties} [properties] The custom data.

serializedName

serializedName: string = "Job"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Job"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "JobProperties"

name

name: "Composite" = "Composite"

Const JobCollection

JobCollection: object
interface

An interface representing the JobCollection. Collection of jobs.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "JobCollection"

__@iterator

  • __@iterator(): IterableIterator<Job>
  • Iterator

    Returns IterableIterator<Job>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Job>[]): Job[]
  • concat(...items: (T | ConcatArray<T>)[]): Job[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Job>[]

      Additional items to add to the end of array1.

    Returns Job[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Job[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Job]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Job]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Job, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Job

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Job[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): any
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Job[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Job | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • this: void
          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

    Returns Job | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): void
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Job, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Job

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): U
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Job | undefined
  • Removes the last element from an array and returns it.

    Returns Job | undefined

push

  • push(...items: Job[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Job[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Job
  • reduce(callbackfn: function, initialValue: Job): Job
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Job
  • reduceRight(callbackfn: function, initialValue: Job): Job
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Job[]
  • Reverses the elements in an Array.

    Returns Job[]

shift

  • shift(): Job | undefined
  • Removes the first element from an array and returns it.

    Returns Job | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Job[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Job[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Job[]
  • splice(start: number, deleteCount: number, ...items: Job[]): Job[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Job[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Job[]

      Elements to insert into the array in place of the deleted elements.

    Returns Job[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Job[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Job[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Job>
  • Returns an iterable of values in the array

    Returns IterableIterator<Job>

type

type: object

className

className: string = "JobCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

Const JobDetails

JobDetails: object
interface

An interface representing JobDetails. Job details based on specific job type.

Optional affectedObjectDetails

affectedObjectDetails: undefined | object
member

{{ [propertyName: string]: string }} [affectedObjectDetails] The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.

instanceType

instanceType: "JobDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "JobDetails"

type

type: object

className

className: string = "JobDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "JobDetails"

modelProperties

modelProperties: object

affectedObjectDetails

affectedObjectDetails: object

serializedName

serializedName: string = "affectedObjectDetails"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const JobEntity

JobEntity: object
interface

An interface representing JobEntity. This class contains the minimal job details required to navigate to the desired drill down.

Optional jobFriendlyName

jobFriendlyName: undefined | string
member

{string} [jobFriendlyName] The job display name.

Optional jobId

jobId: undefined | string
member

{string} [jobId] The job id.

Optional jobScenarioName

jobScenarioName: undefined | string
member

{string} [jobScenarioName] The job name. Enum type ScenarioName.

Optional targetInstanceType

targetInstanceType: undefined | string
member

{string} [targetInstanceType] The workflow affected object type.

Optional targetObjectId

targetObjectId: undefined | string
member

{string} [targetObjectId] The object id.

Optional targetObjectName

targetObjectName: undefined | string
member

{string} [targetObjectName] The object name.

serializedName

serializedName: string = "JobEntity"

type

type: object

className

className: string = "JobEntity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobFriendlyName

jobFriendlyName: object

serializedName

serializedName: string = "jobFriendlyName"

type

type: object

name

name: "String" = "String"

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

jobScenarioName

jobScenarioName: object

serializedName

serializedName: string = "jobScenarioName"

type

type: object

name

name: "String" = "String"

targetInstanceType

targetInstanceType: object

serializedName

serializedName: string = "targetInstanceType"

type

type: object

name

name: "String" = "String"

targetObjectId

targetObjectId: object

serializedName

serializedName: string = "targetObjectId"

type

type: object

name

name: "String" = "String"

targetObjectName

targetObjectName: object

serializedName

serializedName: string = "targetObjectName"

type

type: object

name

name: "String" = "String"

Const JobErrorDetails

JobErrorDetails: object
interface

An interface representing JobErrorDetails. This class contains the error details per object.

Optional creationTime

creationTime: Date
member

{Date} [creationTime] The creation time of job error.

Optional errorLevel

errorLevel: undefined | string
member

{string} [errorLevel] Error level of error.

Optional providerErrorDetails

providerErrorDetails: ProviderError
member

{ProviderError} [providerErrorDetails] The Provider error details.

Optional serviceErrorDetails

serviceErrorDetails: ServiceError
member

{ServiceError} [serviceErrorDetails] The Service error details.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The Id of the task.

serializedName

serializedName: string = "JobErrorDetails"

type

type: object

className

className: string = "JobErrorDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

errorLevel

errorLevel: object

serializedName

serializedName: string = "errorLevel"

type

type: object

name

name: "String" = "String"

providerErrorDetails

providerErrorDetails: object

serializedName

serializedName: string = "providerErrorDetails"

type

type: object

className

className: string = "ProviderError"

name

name: "Composite" = "Composite"

serviceErrorDetails

serviceErrorDetails: object

serializedName

serializedName: string = "serviceErrorDetails"

type

type: object

className

className: string = "ServiceError"

name

name: "Composite" = "Composite"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const JobProperties

JobProperties: object
interface

An interface representing JobProperties. Job custom data details.

Optional activityId

activityId: undefined | string
member

{string} [activityId] The activity id.

Optional allowedActions

allowedActions: string[]
member

{string[]} [allowedActions] The Allowed action the job.

Optional customDetails

customDetails: JobDetailsUnion
member

{JobDetailsUnion} [customDetails] The custom job details like test failover job details.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional errors

errors: JobErrorDetails[]
member

{JobErrorDetails[]} [errors] The errors.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The DisplayName.

Optional scenarioName

scenarioName: undefined | string
member

{string} [scenarioName] The ScenarioName.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional state

state: undefined | string
member

{string} [state] The status of the Job. It is one of these values

  • NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.

Optional stateDescription

stateDescription: undefined | string
member

{string} [stateDescription] The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.

Optional targetInstanceType

targetInstanceType: undefined | string
member

{string} [targetInstanceType] The type of the affected object which is of {Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType} class.

Optional targetObjectId

targetObjectId: undefined | string
member

{string} [targetObjectId] The affected Object Id.

Optional targetObjectName

targetObjectName: undefined | string
member

{string} [targetObjectName] The name of the affected object.

Optional tasks

tasks: ASRTask[]
member

{ASRTask[]} [tasks] The tasks.

serializedName

serializedName: string = "JobProperties"

type

type: object

className

className: string = "JobProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activityId

activityId: object

serializedName

serializedName: string = "activityId"

type

type: object

name

name: "String" = "String"

allowedActions

allowedActions: object

serializedName

serializedName: string = "allowedActions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

customDetails

customDetails: object

serializedName

serializedName: string = "customDetails"

type

type: object

className

className: string = "JobDetails"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobErrorDetails"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

scenarioName

scenarioName: object

serializedName

serializedName: string = "scenarioName"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

stateDescription

stateDescription: object

serializedName

serializedName: string = "stateDescription"

type

type: object

name

name: "String" = "String"

targetInstanceType

targetInstanceType: object

serializedName

serializedName: string = "targetInstanceType"

type

type: object

name

name: "String" = "String"

targetObjectId

targetObjectId: object

serializedName

serializedName: string = "targetObjectId"

type

type: object

name

name: "String" = "String"

targetObjectName

targetObjectName: object

serializedName

serializedName: string = "targetObjectName"

type

type: object

name

name: "String" = "String"

tasks

tasks: object

serializedName

serializedName: string = "tasks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ASRTask"

name

name: "Composite" = "Composite"

Const JobQueryParameter

JobQueryParameter: object
interface

An interface representing JobQueryParameter. Query parameter to enumerate jobs.

Optional affectedObjectTypes

affectedObjectTypes: undefined | string
member

{string} [affectedObjectTypes] The type of objects.

Optional endTime

endTime: undefined | string
member

{string} [endTime] Date time to get jobs upto.

Optional fabricId

fabricId: undefined | string
member

{string} [fabricId] The Id of the fabric to search jobs under.

Optional jobStatus

jobStatus: undefined | string
member

{string} [jobStatus] The states of the job to be filtered can be in.

Optional startTime

startTime: undefined | string
member

{string} [startTime] Date time to get jobs from.

serializedName

serializedName: string = "JobQueryParameter"

type

type: object

className

className: string = "JobQueryParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affectedObjectTypes

affectedObjectTypes: object

serializedName

serializedName: string = "affectedObjectTypes"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "String" = "String"

fabricId

fabricId: object

serializedName

serializedName: string = "fabricId"

type

type: object

name

name: "String" = "String"

jobStatus

jobStatus: object

serializedName

serializedName: string = "jobStatus"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "String" = "String"

Const JobStatusEventDetails

JobStatusEventDetails: object
interface

An interface representing JobStatusEventDetails. Model class for event details of a job status event.

Optional affectedObjectType

affectedObjectType: undefined | string
member

{string} [affectedObjectType] AffectedObjectType for the event.

instanceType

instanceType: "JobStatus"
member

{string} instanceType Polymorphic Discriminator

Optional jobFriendlyName

jobFriendlyName: undefined | string
member

{string} [jobFriendlyName] JobName for the Event.

Optional jobId

jobId: undefined | string
member

{string} [jobId] Job arm id for the event.

Optional jobStatus

jobStatus: undefined | string
member

{string} [jobStatus] JobStatus for the Event.

serializedName

serializedName: string = "JobStatus"

type

type: object

className

className: string = "JobStatusEventDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EventSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "EventSpecificDetails"

modelProperties

modelProperties: object

affectedObjectType

affectedObjectType: object

serializedName

serializedName: string = "affectedObjectType"

type

type: object

name

name: "String" = "String"

jobFriendlyName

jobFriendlyName: object

serializedName

serializedName: string = "jobFriendlyName"

type

type: object

name

name: "String" = "String"

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

jobStatus

jobStatus: object

serializedName

serializedName: string = "jobStatus"

type

type: object

name

name: "String" = "String"

Const JobTaskDetails

JobTaskDetails: object
interface

An interface representing JobTaskDetails. This class represents a task which is actually a workflow so that one can navigate to its individual drill down.

instanceType

instanceType: "JobTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional jobTask

jobTask: JobEntity
member

{JobEntity} [jobTask] The job entity.

serializedName

serializedName: string = "JobTaskDetails"

type

type: object

className

className: string = "JobTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

jobTask

jobTask: object

serializedName

serializedName: string = "jobTask"

type

type: object

className

className: string = "JobEntity"

name

name: "Composite" = "Composite"

Const KeyEncryptionKeyInfo

KeyEncryptionKeyInfo: object
interface

An interface representing KeyEncryptionKeyInfo. Key Encryption Key (KEK) information.

Optional keyIdentifier

keyIdentifier: undefined | string
member

{string} [keyIdentifier] The key url / identifier.

Optional keyVaultResourceArmId

keyVaultResourceArmId: undefined | string
member

{string} [keyVaultResourceArmId] The KeyVault resource ARM id for key.

serializedName

serializedName: string = "KeyEncryptionKeyInfo"

type

type: object

className

className: string = "KeyEncryptionKeyInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyIdentifier

keyIdentifier: object

serializedName

serializedName: string = "keyIdentifier"

type

type: object

name

name: "String" = "String"

keyVaultResourceArmId

keyVaultResourceArmId: object

serializedName

serializedName: string = "keyVaultResourceArmId"

type

type: object

name

name: "String" = "String"

Const LogicalNetwork

LogicalNetwork: object
interface

An interface representing LogicalNetwork. Logical network data model.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{LogicalNetworkProperties} [properties] The Logical Network Properties.

serializedName

serializedName: string = "LogicalNetwork"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LogicalNetwork"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "LogicalNetworkProperties"

name

name: "Composite" = "Composite"

Const LogicalNetworkCollection

LogicalNetworkCollection: object
interface

An interface representing the LogicalNetworkCollection. List of logical networks.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "LogicalNetworkCollection"

__@iterator

  • Iterator

    Returns IterableIterator<LogicalNetwork>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LogicalNetwork>[]

      Additional items to add to the end of array1.

    Returns LogicalNetwork[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LogicalNetwork[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LogicalNetwork]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LogicalNetwork, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LogicalNetwork

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LogicalNetwork[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LogicalNetwork[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LogicalNetwork | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LogicalNetwork | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LogicalNetwork, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LogicalNetwork

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LogicalNetwork, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LogicalNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LogicalNetwork, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LogicalNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LogicalNetwork | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LogicalNetwork

  • Parameters

    Returns LogicalNetwork

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LogicalNetwork

  • Parameters

    Returns LogicalNetwork

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LogicalNetwork[]

shift

  • Removes the first element from an array and returns it.

    Returns LogicalNetwork | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LogicalNetwork[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LogicalNetwork[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LogicalNetwork[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LogicalNetwork[]

      Elements to insert into the array in place of the deleted elements.

    Returns LogicalNetwork[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LogicalNetwork[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LogicalNetwork>

type

type: object

className

className: string = "LogicalNetworkCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogicalNetwork"

name

name: "Composite" = "Composite"

Const LogicalNetworkProperties

LogicalNetworkProperties: object
interface

An interface representing LogicalNetworkProperties. Logical Network Properties.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The Friendly Name.

Optional logicalNetworkDefinitionsStatus

logicalNetworkDefinitionsStatus: undefined | string
member

{string} [logicalNetworkDefinitionsStatus] A value indicating whether logical network definitions are isolated.

Optional logicalNetworkUsage

logicalNetworkUsage: undefined | string
member

{string} [logicalNetworkUsage] A value indicating whether logical network is used as private test network by test failover.

Optional networkVirtualizationStatus

networkVirtualizationStatus: undefined | string
member

{string} [networkVirtualizationStatus] A value indicating whether Network Virtualization is enabled for the logical network.

serializedName

serializedName: string = "LogicalNetworkProperties"

type

type: object

className

className: string = "LogicalNetworkProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

logicalNetworkDefinitionsStatus

logicalNetworkDefinitionsStatus: object

serializedName

serializedName: string = "logicalNetworkDefinitionsStatus"

type

type: object

name

name: "String" = "String"

logicalNetworkUsage

logicalNetworkUsage: object

serializedName

serializedName: string = "logicalNetworkUsage"

type

type: object

name

name: "String" = "String"

networkVirtualizationStatus

networkVirtualizationStatus: object

serializedName

serializedName: string = "networkVirtualizationStatus"

type

type: object

name

name: "String" = "String"

Const ManualActionTaskDetails

ManualActionTaskDetails: object
interface

An interface representing ManualActionTaskDetails. This class represents the manual action task details.

instanceType

instanceType: "ManualActionTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional instructions

instructions: undefined | string
member

{string} [instructions] The instructions.

Optional name

name: undefined | string
member

{string} [name] The name.

Optional observation

observation: undefined | string
member

{string} [observation] The observation.

serializedName

serializedName: string = "ManualActionTaskDetails"

type

type: object

className

className: string = "ManualActionTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

instructions

instructions: object

serializedName

serializedName: string = "instructions"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

observation

observation: object

serializedName

serializedName: string = "observation"

type

type: object

name

name: "String" = "String"

Const MasterTargetServer

MasterTargetServer: object
interface

An interface representing MasterTargetServer. Details of a Master Target Server.

Optional agentExpiryDate

agentExpiryDate: Date
member

{Date} [agentExpiryDate] Agent expiry date.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The version of the scout component on the server.

Optional agentVersionDetails

agentVersionDetails: VersionDetails
member

{VersionDetails} [agentVersionDetails] Agent version details.

Optional dataStores

dataStores: DataStore[]
member

{DataStore[]} [dataStores] The list of data stores in the fabric.

Optional diskCount

diskCount: undefined | number
member

{number} [diskCount] Disk count of the master target.

Optional healthErrors

healthErrors: HealthError[]
member

{HealthError[]} [healthErrors] Health errors.

Optional id

id: undefined | string
member

{string} [id] The server Id.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of the server.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The last heartbeat received from the server.

Optional marsAgentExpiryDate

marsAgentExpiryDate: Date
member

{Date} [marsAgentExpiryDate] MARS agent expiry date.

Optional marsAgentVersion

marsAgentVersion: undefined | string
member

{string} [marsAgentVersion] MARS agent version.

Optional marsAgentVersionDetails

marsAgentVersionDetails: VersionDetails
member

{VersionDetails} [marsAgentVersionDetails] Mars agent version details.

Optional name

name: undefined | string
member

{string} [name] The server name.

Optional osType

osType: undefined | string
member

{string} [osType] The OS type of the server.

Optional osVersion

osVersion: undefined | string
member

{string} [osVersion] OS Version of the master target.

Optional retentionVolumes

retentionVolumes: RetentionVolume[]
member

{RetentionVolume[]} [retentionVolumes] The retention volumes of Master target Server.

Optional validationErrors

validationErrors: HealthError[]
member

{HealthError[]} [validationErrors] Validation errors.

Optional versionStatus

versionStatus: undefined | string
member

{string} [versionStatus] Version status

serializedName

serializedName: string = "MasterTargetServer"

type

type: object

className

className: string = "MasterTargetServer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

agentExpiryDate

agentExpiryDate: object

serializedName

serializedName: string = "agentExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

agentVersionDetails

agentVersionDetails: object

serializedName

serializedName: string = "agentVersionDetails"

type

type: object

className

className: string = "VersionDetails"

name

name: "Composite" = "Composite"

dataStores

dataStores: object

serializedName

serializedName: string = "dataStores"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataStore"

name

name: "Composite" = "Composite"

diskCount

diskCount: object

serializedName

serializedName: string = "diskCount"

type

type: object

name

name: "Number" = "Number"

healthErrors

healthErrors: object

serializedName

serializedName: string = "healthErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

marsAgentExpiryDate

marsAgentExpiryDate: object

serializedName

serializedName: string = "marsAgentExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

marsAgentVersion

marsAgentVersion: object

serializedName

serializedName: string = "marsAgentVersion"

type

type: object

name

name: "String" = "String"

marsAgentVersionDetails

marsAgentVersionDetails: object

serializedName

serializedName: string = "marsAgentVersionDetails"

type

type: object

className

className: string = "VersionDetails"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

osVersion

osVersion: object

serializedName

serializedName: string = "osVersion"

type

type: object

name

name: "String" = "String"

retentionVolumes

retentionVolumes: object

serializedName

serializedName: string = "retentionVolumes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RetentionVolume"

name

name: "Composite" = "Composite"

validationErrors

validationErrors: object

serializedName

serializedName: string = "validationErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

versionStatus

versionStatus: object

serializedName

serializedName: string = "versionStatus"

type

type: object

name

name: "String" = "String"

Const MobilityServiceUpdate

MobilityServiceUpdate: object
interface

An interface representing MobilityServiceUpdate. The Mobility Service update details.

Optional osType

osType: undefined | string
member

{string} [osType] The OS type.

Optional rebootStatus

rebootStatus: undefined | string
member

{string} [rebootStatus] The reboot status of the update - whether it is required or not.

Optional version

version: undefined | string
member

{string} [version] The version of the latest update.

serializedName

serializedName: string = "MobilityServiceUpdate"

type

type: object

className

className: string = "MobilityServiceUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

rebootStatus

rebootStatus: object

serializedName

serializedName: string = "rebootStatus"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const Network

Network: object
interface

An interface representing Network. Network model.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: NetworkProperties
member

{NetworkProperties} [properties] The Network Properties.

serializedName

serializedName: string = "Network"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Network"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "NetworkProperties"

name

name: "Composite" = "Composite"

Const NetworkCollection

NetworkCollection: object
interface

An interface representing the NetworkCollection. List of networks.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "NetworkCollection"

__@iterator

  • __@iterator(): IterableIterator<Network>
  • Iterator

    Returns IterableIterator<Network>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Network>[]): Network[]
  • concat(...items: (T | ConcatArray<T>)[]): Network[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Network>[]

      Additional items to add to the end of array1.

    Returns Network[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Network[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Network]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Network]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Network, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Network

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Network[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Network[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Network | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Network, index: number, obj: Network[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Network | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Network, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Network

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Network, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Network

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Network, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Network

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Network | undefined

push

  • push(...items: Network[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Network[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Network
  • reduce(callbackfn: function, initialValue: Network): Network
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Network

  • Parameters

    Returns Network

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Network, currentIndex: number, array: Network[]): U
        • Parameters

          • previousValue: U
          • currentValue: Network
          • currentIndex: number
          • array: Network[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Network
  • reduceRight(callbackfn: function, initialValue: Network): Network
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Network

  • Parameters

    Returns Network

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Network, currentIndex: number, array: Network[]): U
        • Parameters

          • previousValue: U
          • currentValue: Network
          • currentIndex: number
          • array: Network[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Network[]

shift

  • Removes the first element from an array and returns it.

    Returns Network | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Network[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Network[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Network[]
  • splice(start: number, deleteCount: number, ...items: Network[]): Network[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Network[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Network[]

      Elements to insert into the array in place of the deleted elements.

    Returns Network[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Network[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Network[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Network>
  • Returns an iterable of values in the array

    Returns IterableIterator<Network>

type

type: object

className

className: string = "NetworkCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Network"

name

name: "Composite" = "Composite"

Const NetworkMapping

NetworkMapping: object
interface

An interface representing NetworkMapping. Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate exensions in subsequent versions.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{NetworkMappingProperties} [properties] The Network Mapping Properties.

serializedName

serializedName: string = "NetworkMapping"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "NetworkMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "NetworkMappingProperties"

name

name: "Composite" = "Composite"

Const NetworkMappingCollection

NetworkMappingCollection: object
interface

An interface representing the NetworkMappingCollection. List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "NetworkMappingCollection"

__@iterator

  • Iterator

    Returns IterableIterator<NetworkMapping>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkMapping>[]

      Additional items to add to the end of array1.

    Returns NetworkMapping[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkMapping[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkMapping]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkMapping, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkMapping

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkMapping[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkMapping[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkMapping | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns NetworkMapping | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkMapping, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkMapping

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkMapping, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkMapping

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkMapping, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkMapping

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns NetworkMapping | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NetworkMapping

  • Parameters

    Returns NetworkMapping

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NetworkMapping

  • Parameters

    Returns NetworkMapping

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns NetworkMapping[]

shift

  • Removes the first element from an array and returns it.

    Returns NetworkMapping | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkMapping[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkMapping[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkMapping[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkMapping[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkMapping[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkMapping[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkMapping>

type

type: object

className

className: string = "NetworkMappingCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkMapping"

name

name: "Composite" = "Composite"

Const NetworkMappingFabricSpecificSettings

NetworkMappingFabricSpecificSettings: object
interface

An interface representing NetworkMappingFabricSpecificSettings. Network Mapping fabric specific settings.

instanceType

instanceType: "NetworkMappingFabricSpecificSettings"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "NetworkMappingFabricSpecificSettings"

type

type: object

className

className: string = "NetworkMappingFabricSpecificSettings"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "NetworkMappingFabricSpecificSettings"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const NetworkMappingProperties

NetworkMappingProperties: object
interface

An interface representing NetworkMappingProperties. Network Mapping Properties.

Optional fabricSpecificSettings

member

{NetworkMappingFabricSpecificSettingsUnion} [fabricSpecificSettings] The fabric specific settings.

Optional primaryFabricFriendlyName

primaryFabricFriendlyName: undefined | string
member

{string} [primaryFabricFriendlyName] The primary fabric friendly name.

Optional primaryNetworkFriendlyName

primaryNetworkFriendlyName: undefined | string
member

{string} [primaryNetworkFriendlyName] The primary network friendly name.

Optional primaryNetworkId

primaryNetworkId: undefined | string
member

{string} [primaryNetworkId] The primary network id for network mapping.

Optional recoveryFabricArmId

recoveryFabricArmId: undefined | string
member

{string} [recoveryFabricArmId] The recovery fabric ARM id.

Optional recoveryFabricFriendlyName

recoveryFabricFriendlyName: undefined | string
member

{string} [recoveryFabricFriendlyName] The recovery fabric friendly name.

Optional recoveryNetworkFriendlyName

recoveryNetworkFriendlyName: undefined | string
member

{string} [recoveryNetworkFriendlyName] The recovery network friendly name.

Optional recoveryNetworkId

recoveryNetworkId: undefined | string
member

{string} [recoveryNetworkId] The recovery network id for network mapping.

Optional state

state: undefined | string
member

{string} [state] The pairing state for network mapping.

serializedName

serializedName: string = "NetworkMappingProperties"

type

type: object

className

className: string = "NetworkMappingProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fabricSpecificSettings

fabricSpecificSettings: object

serializedName

serializedName: string = "fabricSpecificSettings"

type

type: object

className

className: string = "NetworkMappingFabricSpecificSettings"

name

name: "Composite" = "Composite"

primaryFabricFriendlyName

primaryFabricFriendlyName: object

serializedName

serializedName: string = "primaryFabricFriendlyName"

type

type: object

name

name: "String" = "String"

primaryNetworkFriendlyName

primaryNetworkFriendlyName: object

serializedName

serializedName: string = "primaryNetworkFriendlyName"

type

type: object

name

name: "String" = "String"

primaryNetworkId

primaryNetworkId: object

serializedName

serializedName: string = "primaryNetworkId"

type

type: object

name

name: "String" = "String"

recoveryFabricArmId

recoveryFabricArmId: object

serializedName

serializedName: string = "recoveryFabricArmId"

type

type: object

name

name: "String" = "String"

recoveryFabricFriendlyName

recoveryFabricFriendlyName: object

serializedName

serializedName: string = "recoveryFabricFriendlyName"

type

type: object

name

name: "String" = "String"

recoveryNetworkFriendlyName

recoveryNetworkFriendlyName: object

serializedName

serializedName: string = "recoveryNetworkFriendlyName"

type

type: object

name

name: "String" = "String"

recoveryNetworkId

recoveryNetworkId: object

serializedName

serializedName: string = "recoveryNetworkId"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const NetworkProperties

NetworkProperties: object
interface

An interface representing NetworkProperties. Network Properties

Optional fabricType

fabricType: undefined | string
member

{string} [fabricType] The Fabric Type.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The Friendly Name.

Optional networkType

networkType: undefined | string
member

{string} [networkType] The Network Type.

Optional subnets

subnets: Subnet[]
member

{Subnet[]} [subnets] The List of subnets.

serializedName

serializedName: string = "NetworkProperties"

type

type: object

className

className: string = "NetworkProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fabricType

fabricType: object

serializedName

serializedName: string = "fabricType"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

networkType

networkType: object

serializedName

serializedName: string = "networkType"

type

type: object

name

name: "String" = "String"

subnets

subnets: object

serializedName

serializedName: string = "subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const OSDetails

OSDetails: object
interface

An interface representing OSDetails. Disk Details.

Optional oSMajorVersion

oSMajorVersion: undefined | string
member

{string} [oSMajorVersion] The OS Major Version.

Optional oSMinorVersion

oSMinorVersion: undefined | string
member

{string} [oSMinorVersion] The OS Minor Version.

Optional oSVersion

oSVersion: undefined | string
member

{string} [oSVersion] The OS Version.

Optional osEdition

osEdition: undefined | string
member

{string} [osEdition] The OSEdition.

Optional osType

osType: undefined | string
member

{string} [osType] VM Disk details.

Optional productType

productType: undefined | string
member

{string} [productType] Product type.

serializedName

serializedName: string = "OSDetails"

type

type: object

className

className: string = "OSDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oSMajorVersion

oSMajorVersion: object

serializedName

serializedName: string = "oSMajorVersion"

type

type: object

name

name: "String" = "String"

oSMinorVersion

oSMinorVersion: object

serializedName

serializedName: string = "oSMinorVersion"

type

type: object

name

name: "String" = "String"

oSVersion

oSVersion: object

serializedName

serializedName: string = "oSVersion"

type

type: object

name

name: "String" = "String"

osEdition

osEdition: object

serializedName

serializedName: string = "osEdition"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

productType

productType: object

serializedName

serializedName: string = "productType"

type

type: object

name

name: "String" = "String"

Const OSDiskDetails

OSDiskDetails: object
interface

An interface representing OSDiskDetails. Details of the OS Disk.

Optional osType

osType: undefined | string
member

{string} [osType] The type of the OS on the VM.

Optional osVhdId

osVhdId: undefined | string
member

{string} [osVhdId] The id of the disk containing the OS.

Optional vhdName

vhdName: undefined | string
member

{string} [vhdName] The OS disk VHD name.

serializedName

serializedName: string = "OSDiskDetails"

type

type: object

className

className: string = "OSDiskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

osVhdId

osVhdId: object

serializedName

serializedName: string = "osVhdId"

type

type: object

name

name: "String" = "String"

vhdName

vhdName: object

serializedName

serializedName: string = "vhdName"

type

type: object

name

name: "String" = "String"

Const OperationsDiscovery

OperationsDiscovery: object
interface

An interface representing OperationsDiscovery. Operations discovery class.

Optional display

display: Display
member

{Display} [display] Object type

Optional name

name: undefined | string
member

{string} [name] Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the "{Resource Provider Namespace}/register/action" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release)

Optional origin

origin: undefined | string
member

{string} [origin] Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system"

Optional properties

properties: any
member

{any} [properties] Properties. Reserved for future use.

serializedName

serializedName: string = "OperationsDiscovery"

type

type: object

className

className: string = "OperationsDiscovery"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "Display"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Object" = "Object"

Const OperationsDiscoveryCollection

OperationsDiscoveryCollection: object
interface

An interface representing the OperationsDiscoveryCollection. Collection of ClientDiscovery details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "OperationsDiscoveryCollection"

__@iterator

  • Iterator

    Returns IterableIterator<OperationsDiscovery>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<OperationsDiscovery>[]

      Additional items to add to the end of array1.

    Returns OperationsDiscovery[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns OperationsDiscovery[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, OperationsDiscovery]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: OperationsDiscovery

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): OperationsDiscovery[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns OperationsDiscovery[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): OperationsDiscovery | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns OperationsDiscovery | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: OperationsDiscovery

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: OperationsDiscovery

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: OperationsDiscovery

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns OperationsDiscovery | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns OperationsDiscovery

  • Parameters

    Returns OperationsDiscovery

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns OperationsDiscovery

  • Parameters

    Returns OperationsDiscovery

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns OperationsDiscovery[]

shift

  • Removes the first element from an array and returns it.

    Returns OperationsDiscovery | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns OperationsDiscovery[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns OperationsDiscovery[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: OperationsDiscovery[]

      Elements to insert into the array in place of the deleted elements.

    Returns OperationsDiscovery[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<OperationsDiscovery>

type

type: object

className

className: string = "OperationsDiscoveryCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationsDiscovery"

name

name: "Composite" = "Composite"

Const PlannedFailoverInput

PlannedFailoverInput: object
interface

An interface representing PlannedFailoverInput. Input definition for planned failover.

Optional properties

member

{PlannedFailoverInputProperties} [properties] Planned failover input properties

serializedName

serializedName: string = "PlannedFailoverInput"

type

type: object

className

className: string = "PlannedFailoverInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "PlannedFailoverInputProperties"

name

name: "Composite" = "Composite"

Const PlannedFailoverInputProperties

PlannedFailoverInputProperties: object
interface

An interface representing PlannedFailoverInputProperties. Input definition for planned failover input properties.

Optional failoverDirection

failoverDirection: undefined | string
member

{string} [failoverDirection] Failover direction.

Optional providerSpecificDetails

providerSpecificDetails: ProviderSpecificFailoverInputUnion
member

{ProviderSpecificFailoverInputUnion} [providerSpecificDetails] Provider specific settings

serializedName

serializedName: string = "PlannedFailoverInputProperties"

type

type: object

className

className: string = "PlannedFailoverInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

Const Policy

Policy: object
interface

An interface representing Policy. Protection profile details.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: PolicyProperties
member

{PolicyProperties} [properties] The custom data.

serializedName

serializedName: string = "Policy"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Policy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "PolicyProperties"

name

name: "Composite" = "Composite"

Const PolicyCollection

PolicyCollection: object
interface

An interface representing the PolicyCollection. Protection Profile Collection details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "PolicyCollection"

__@iterator

  • __@iterator(): IterableIterator<Policy>
  • Iterator

    Returns IterableIterator<Policy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Policy>[]): Policy[]
  • concat(...items: (T | ConcatArray<T>)[]): Policy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Policy>[]

      Additional items to add to the end of array1.

    Returns Policy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Policy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Policy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Policy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Policy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Policy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Policy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Policy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Policy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Policy, index: number, obj: Policy[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Policy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Policy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Policy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Policy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Policy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Policy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Policy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Policy | undefined

push

  • push(...items: Policy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Policy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Policy
  • reduce(callbackfn: function, initialValue: Policy): Policy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Policy

  • Parameters

    Returns Policy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Policy, currentIndex: number, array: Policy[]): U
        • Parameters

          • previousValue: U
          • currentValue: Policy
          • currentIndex: number
          • array: Policy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Policy
  • reduceRight(callbackfn: function, initialValue: Policy): Policy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Policy

  • Parameters

    Returns Policy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Policy, currentIndex: number, array: Policy[]): U
        • Parameters

          • previousValue: U
          • currentValue: Policy
          • currentIndex: number
          • array: Policy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Policy[]

shift

  • Removes the first element from an array and returns it.

    Returns Policy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Policy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Policy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Policy[]
  • splice(start: number, deleteCount: number, ...items: Policy[]): Policy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Policy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Policy[]

      Elements to insert into the array in place of the deleted elements.

    Returns Policy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Policy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Policy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Policy>
  • Returns an iterable of values in the array

    Returns IterableIterator<Policy>

type

type: object

className

className: string = "PolicyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Policy"

name

name: "Composite" = "Composite"

Const PolicyProperties

PolicyProperties: object
interface

An interface representing PolicyProperties. Protection profile custom data details.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The FriendlyName.

Optional providerSpecificDetails

providerSpecificDetails: PolicyProviderSpecificDetailsUnion
member

{PolicyProviderSpecificDetailsUnion} [providerSpecificDetails] The ReplicationChannelSetting.

serializedName

serializedName: string = "PolicyProperties"

type

type: object

className

className: string = "PolicyProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "PolicyProviderSpecificDetails"

name

name: "Composite" = "Composite"

Const PolicyProviderSpecificDetails

PolicyProviderSpecificDetails: object
interface

An interface representing PolicyProviderSpecificDetails. Base class for Provider specific details for policies.

instanceType

instanceType: "PolicyProviderSpecificDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "PolicyProviderSpecificDetails"

type

type: object

className

className: string = "PolicyProviderSpecificDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const PolicyProviderSpecificInput

PolicyProviderSpecificInput: object
interface

An interface representing PolicyProviderSpecificInput. Base class for provider specific input

instanceType

instanceType: "PolicyProviderSpecificInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "PolicyProviderSpecificInput"

type

type: object

className

className: string = "PolicyProviderSpecificInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ProcessServer

ProcessServer: object
interface

An interface representing ProcessServer. Details of the Process Server.

Optional agentExpiryDate

agentExpiryDate: Date
member

{Date} [agentExpiryDate] Agent expiry date.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The version of the scout component on the server.

Optional agentVersionDetails

agentVersionDetails: VersionDetails
member

{VersionDetails} [agentVersionDetails] The agent version details.

Optional availableMemoryInBytes

availableMemoryInBytes: undefined | number
member

{number} [availableMemoryInBytes] The available memory.

Optional availableSpaceInBytes

availableSpaceInBytes: undefined | number
member

{number} [availableSpaceInBytes] The available space.

Optional cpuLoad

cpuLoad: undefined | string
member

{string} [cpuLoad] The percentage of the CPU load.

Optional cpuLoadStatus

cpuLoadStatus: undefined | string
member

{string} [cpuLoadStatus] The CPU load status.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The Process Server's friendly name.

Optional healthErrors

healthErrors: HealthError[]
member

{HealthError[]} [healthErrors] Health errors.

Optional hostId

hostId: undefined | string
member

{string} [hostId] The agent generated Id.

Optional id

id: undefined | string
member

{string} [id] The Process Server Id.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of the server.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The last heartbeat received from the server.

Optional machineCount

machineCount: undefined | string
member

{string} [machineCount] The servers configured with this PS.

Optional memoryUsageStatus

memoryUsageStatus: undefined | string
member

{string} [memoryUsageStatus] The memory usage status.

Optional mobilityServiceUpdates

mobilityServiceUpdates: MobilityServiceUpdate[]
member

{MobilityServiceUpdate[]} [mobilityServiceUpdates] The list of the mobility service updates available on the Process Server.

Optional osType

osType: undefined | string
member

{string} [osType] The OS type of the server.

Optional osVersion

osVersion: undefined | string
member

{string} [osVersion] OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.

Optional psServiceStatus

psServiceStatus: undefined | string
member

{string} [psServiceStatus] The PS service status.

Optional replicationPairCount

replicationPairCount: undefined | string
member

{string} [replicationPairCount] The number of replication pairs configured in this PS.

Optional spaceUsageStatus

spaceUsageStatus: undefined | string
member

{string} [spaceUsageStatus] The space usage status.

Optional sslCertExpiryDate

sslCertExpiryDate: Date
member

{Date} [sslCertExpiryDate] The PS SSL cert expiry date.

Optional sslCertExpiryRemainingDays

sslCertExpiryRemainingDays: undefined | number
member

{number} [sslCertExpiryRemainingDays] CS SSL cert expiry date.

Optional systemLoad

systemLoad: undefined | string
member

{string} [systemLoad] The percentage of the system load.

Optional systemLoadStatus

systemLoadStatus: undefined | string
member

{string} [systemLoadStatus] The system load status.

Optional totalMemoryInBytes

totalMemoryInBytes: undefined | number
member

{number} [totalMemoryInBytes] The total memory.

Optional totalSpaceInBytes

totalSpaceInBytes: undefined | number
member

{number} [totalSpaceInBytes] The total space.

Optional versionStatus

versionStatus: undefined | string
member

{string} [versionStatus] Version status

serializedName

serializedName: string = "ProcessServer"

type

type: object

className

className: string = "ProcessServer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

agentExpiryDate

agentExpiryDate: object

serializedName

serializedName: string = "agentExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

agentVersionDetails

agentVersionDetails: object

serializedName

serializedName: string = "agentVersionDetails"

type

type: object

className

className: string = "VersionDetails"

name

name: "Composite" = "Composite"

availableMemoryInBytes

availableMemoryInBytes: object

serializedName

serializedName: string = "availableMemoryInBytes"

type

type: object

name

name: "Number" = "Number"

availableSpaceInBytes

availableSpaceInBytes: object

serializedName

serializedName: string = "availableSpaceInBytes"

type

type: object

name

name: "Number" = "Number"

cpuLoad

cpuLoad: object

serializedName

serializedName: string = "cpuLoad"

type

type: object

name

name: "String" = "String"

cpuLoadStatus

cpuLoadStatus: object

serializedName

serializedName: string = "cpuLoadStatus"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthErrors

healthErrors: object

serializedName

serializedName: string = "healthErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

hostId

hostId: object

serializedName

serializedName: string = "hostId"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

machineCount

machineCount: object

serializedName

serializedName: string = "machineCount"

type

type: object

name

name: "String" = "String"

memoryUsageStatus

memoryUsageStatus: object

serializedName

serializedName: string = "memoryUsageStatus"

type

type: object

name

name: "String" = "String"

mobilityServiceUpdates

mobilityServiceUpdates: object

serializedName

serializedName: string = "mobilityServiceUpdates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MobilityServiceUpdate"

name

name: "Composite" = "Composite"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

osVersion

osVersion: object

serializedName

serializedName: string = "osVersion"

type

type: object

name

name: "String" = "String"

psServiceStatus

psServiceStatus: object

serializedName

serializedName: string = "psServiceStatus"

type

type: object

name

name: "String" = "String"

replicationPairCount

replicationPairCount: object

serializedName

serializedName: string = "replicationPairCount"

type

type: object

name

name: "String" = "String"

spaceUsageStatus

spaceUsageStatus: object

serializedName

serializedName: string = "spaceUsageStatus"

type

type: object

name

name: "String" = "String"

sslCertExpiryDate

sslCertExpiryDate: object

serializedName

serializedName: string = "sslCertExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

sslCertExpiryRemainingDays

sslCertExpiryRemainingDays: object

serializedName

serializedName: string = "sslCertExpiryRemainingDays"

type

type: object

name

name: "Number" = "Number"

systemLoad

systemLoad: object

serializedName

serializedName: string = "systemLoad"

type

type: object

name

name: "String" = "String"

systemLoadStatus

systemLoadStatus: object

serializedName

serializedName: string = "systemLoadStatus"

type

type: object

name

name: "String" = "String"

totalMemoryInBytes

totalMemoryInBytes: object

serializedName

serializedName: string = "totalMemoryInBytes"

type

type: object

name

name: "Number" = "Number"

totalSpaceInBytes

totalSpaceInBytes: object

serializedName

serializedName: string = "totalSpaceInBytes"

type

type: object

name

name: "Number" = "Number"

versionStatus

versionStatus: object

serializedName

serializedName: string = "versionStatus"

type

type: object

name

name: "String" = "String"

Const ProtectableItem

ProtectableItem: object
interface

An interface representing ProtectableItem. Replication protected item

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{ProtectableItemProperties} [properties] The custom data.

serializedName

serializedName: string = "ProtectableItem"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProtectableItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectableItemProperties"

name

name: "Composite" = "Composite"

Const ProtectableItemCollection

ProtectableItemCollection: object
interface

An interface representing the ProtectableItemCollection. Protectable item collection.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "ProtectableItemCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ProtectableItem>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectableItem>[]

      Additional items to add to the end of array1.

    Returns ProtectableItem[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectableItem[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectableItem]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProtectableItem, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectableItem

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectableItem[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectableItem[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectableItem | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ProtectableItem | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProtectableItem, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectableItem

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProtectableItem, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectableItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProtectableItem, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectableItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ProtectableItem | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProtectableItem

  • Parameters

    Returns ProtectableItem

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProtectableItem

  • Parameters

    Returns ProtectableItem

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ProtectableItem[]

shift

  • Removes the first element from an array and returns it.

    Returns ProtectableItem | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProtectableItem[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectableItem[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectableItem[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectableItem[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectableItem[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProtectableItem[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectableItem>

type

type: object

className

className: string = "ProtectableItemCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectableItem"

name

name: "Composite" = "Composite"

Const ProtectableItemProperties

ProtectableItemProperties: object
interface

An interface representing ProtectableItemProperties. Replication protected item custom data details.

Optional customDetails

member

{ConfigurationSettingsUnion} [customDetails] The Replication provider custom settings.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The name.

Optional protectionReadinessErrors

protectionReadinessErrors: string[]
member

{string[]} [protectionReadinessErrors] The Current protection readiness errors.

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] The protection status.

Optional recoveryServicesProviderId

recoveryServicesProviderId: undefined | string
member

{string} [recoveryServicesProviderId] The recovery provider ARM Id.

Optional replicationProtectedItemId

replicationProtectedItemId: undefined | string
member

{string} [replicationProtectedItemId] The ARM resource of protected items.

Optional supportedReplicationProviders

supportedReplicationProviders: string[]
member

{string[]} [supportedReplicationProviders] The list of replication providers supported for the protectable item.

serializedName

serializedName: string = "ProtectableItemProperties"

type

type: object

className

className: string = "ProtectableItemProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customDetails

customDetails: object

serializedName

serializedName: string = "customDetails"

type

type: object

className

className: string = "ConfigurationSettings"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

protectionReadinessErrors

protectionReadinessErrors: object

serializedName

serializedName: string = "protectionReadinessErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

recoveryServicesProviderId

recoveryServicesProviderId: object

serializedName

serializedName: string = "recoveryServicesProviderId"

type

type: object

name

name: "String" = "String"

replicationProtectedItemId

replicationProtectedItemId: object

serializedName

serializedName: string = "replicationProtectedItemId"

type

type: object

name

name: "String" = "String"

supportedReplicationProviders

supportedReplicationProviders: object

serializedName

serializedName: string = "supportedReplicationProviders"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ProtectableItemQueryParameter

ProtectableItemQueryParameter: object
interface

An interface representing ProtectableItemQueryParameter. Query parameter to enumerate Protectable items.

Optional state

state: undefined | string
member

{string} [state] State of the Protectable item query filter.

serializedName

serializedName: string = "ProtectableItemQueryParameter"

type

type: object

className

className: string = "ProtectableItemQueryParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const ProtectedItemsQueryParameter

ProtectedItemsQueryParameter: object
interface

An interface representing ProtectedItemsQueryParameter. Query parameter to enumerate protected items.

Optional instanceType

instanceType: undefined | string
member

{string} [instanceType] The replication provider type.

Optional multiVmGroupCreateOption

multiVmGroupCreateOption: MultiVmGroupCreateOption
member

{MultiVmGroupCreateOption} [multiVmGroupCreateOption] Whether Multi VM group is auto created or specified by user. Possible values include: 'AutoCreated', 'UserSpecified'

Optional recoveryPlanName

recoveryPlanName: undefined | string
member

{string} [recoveryPlanName] The recovery plan filter.

Optional sourceFabricName

sourceFabricName: undefined | string
member

{string} [sourceFabricName] The source fabric name filter.

Optional vCenterName

vCenterName: undefined | string
member

{string} [vCenterName] The vCenter name filter.

serializedName

serializedName: string = "ProtectedItemsQueryParameter"

type

type: object

className

className: string = "ProtectedItemsQueryParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceType

instanceType: object

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

multiVmGroupCreateOption

multiVmGroupCreateOption: object

serializedName

serializedName: string = "multiVmGroupCreateOption"

type

type: object

name

name: "String" = "String"

recoveryPlanName

recoveryPlanName: object

serializedName

serializedName: string = "recoveryPlanName"

type

type: object

name

name: "String" = "String"

sourceFabricName

sourceFabricName: object

serializedName

serializedName: string = "sourceFabricName"

type

type: object

name

name: "String" = "String"

vCenterName

vCenterName: object

serializedName

serializedName: string = "vCenterName"

type

type: object

name

name: "String" = "String"

Const ProtectionContainer

ProtectionContainer: object
interface

An interface representing ProtectionContainer. Protection container details.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{ProtectionContainerProperties} [properties] The custom data.

serializedName

serializedName: string = "ProtectionContainer"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProtectionContainer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectionContainerProperties"

name

name: "Composite" = "Composite"

Const ProtectionContainerCollection

ProtectionContainerCollection: object
interface

An interface representing the ProtectionContainerCollection. Protection Container collection.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "ProtectionContainerCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ProtectionContainer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectionContainer>[]

      Additional items to add to the end of array1.

    Returns ProtectionContainer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectionContainer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectionContainer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectionContainer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectionContainer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectionContainer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectionContainer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ProtectionContainer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectionContainer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectionContainer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectionContainer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ProtectionContainer | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProtectionContainer

  • Parameters

    Returns ProtectionContainer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProtectionContainer

  • Parameters

    Returns ProtectionContainer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ProtectionContainer[]

shift

  • Removes the first element from an array and returns it.

    Returns ProtectionContainer | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectionContainer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectionContainer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectionContainer[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectionContainer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectionContainer>

type

type: object

className

className: string = "ProtectionContainerCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectionContainer"

name

name: "Composite" = "Composite"

Const ProtectionContainerFabricSpecificDetails

ProtectionContainerFabricSpecificDetails: object
interface

An interface representing ProtectionContainerFabricSpecificDetails. Base class for fabric specific details of container.

Optional instanceType

instanceType: undefined | string
member

{string} [instanceType] Gets the class type. Overriden in derived classes. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProtectionContainerFabricSpecificDetails"

type

type: object

className

className: string = "ProtectionContainerFabricSpecificDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceType

instanceType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

Const ProtectionContainerMapping

ProtectionContainerMapping: object
interface

An interface representing ProtectionContainerMapping. Protection container mapping object.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{ProtectionContainerMappingProperties} [properties] The custom data.

serializedName

serializedName: string = "ProtectionContainerMapping"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProtectionContainerMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectionContainerMappingProperties"

name

name: "Composite" = "Composite"

Const ProtectionContainerMappingCollection

ProtectionContainerMappingCollection: object
interface

An interface representing the ProtectionContainerMappingCollection. Protection container mapping collection class.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to fetch rest of the data.

serializedName

serializedName: string = "ProtectionContainerMappingCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ProtectionContainerMapping>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ProtectionContainerMapping[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectionContainerMapping[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectionContainerMapping]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectionContainerMapping

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns ProtectionContainerMapping[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectionContainerMapping | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ProtectionContainerMapping | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectionContainerMapping

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectionContainerMapping

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectionContainerMapping

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ProtectionContainerMapping | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns ProtectionContainerMapping[]

shift

  • Removes the first element from an array and returns it.

    Returns ProtectionContainerMapping | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectionContainerMapping[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectionContainerMapping[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectionContainerMapping[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectionContainerMapping[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectionContainerMapping>

type

type: object

className

className: string = "ProtectionContainerMappingCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectionContainerMapping"

name

name: "Composite" = "Composite"

Const ProtectionContainerMappingProperties

ProtectionContainerMappingProperties: object
interface

An interface representing ProtectionContainerMappingProperties. Protection container mapping properties.

Optional health

health: undefined | string
member

{string} [health] Health of pairing.

Optional healthErrorDetails

healthErrorDetails: HealthError[]
member

{HealthError[]} [healthErrorDetails] Health error.

Optional policyFriendlyName

policyFriendlyName: undefined | string
member

{string} [policyFriendlyName] Friendly name of replication policy.

Optional policyId

policyId: undefined | string
member

{string} [policyId] Policy ARM Id.

Optional providerSpecificDetails

member

{ProtectionContainerMappingProviderSpecificDetailsUnion} [providerSpecificDetails] Provider specific provider details.

Optional sourceFabricFriendlyName

sourceFabricFriendlyName: undefined | string
member

{string} [sourceFabricFriendlyName] Friendly name of source fabric.

Optional sourceProtectionContainerFriendlyName

sourceProtectionContainerFriendlyName: undefined | string
member

{string} [sourceProtectionContainerFriendlyName] Friendly name of source protection container.

Optional state

state: undefined | string
member

{string} [state] Association Status

Optional targetFabricFriendlyName

targetFabricFriendlyName: undefined | string
member

{string} [targetFabricFriendlyName] Friendly name of target fabric.

Optional targetProtectionContainerFriendlyName

targetProtectionContainerFriendlyName: undefined | string
member

{string} [targetProtectionContainerFriendlyName] Friendly name of paired container.

Optional targetProtectionContainerId

targetProtectionContainerId: undefined | string
member

{string} [targetProtectionContainerId] Paired protection container ARM ID.

serializedName

serializedName: string = "ProtectionContainerMappingProperties"

type

type: object

className

className: string = "ProtectionContainerMappingProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

health

health: object

serializedName

serializedName: string = "health"

type

type: object

name

name: "String" = "String"

healthErrorDetails

healthErrorDetails: object

serializedName

serializedName: string = "healthErrorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

policyFriendlyName

policyFriendlyName: object

serializedName

serializedName: string = "policyFriendlyName"

type

type: object

name

name: "String" = "String"

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ProtectionContainerMappingProviderSpecificDetails"

name

name: "Composite" = "Composite"

sourceFabricFriendlyName

sourceFabricFriendlyName: object

serializedName

serializedName: string = "sourceFabricFriendlyName"

type

type: object

name

name: "String" = "String"

sourceProtectionContainerFriendlyName

sourceProtectionContainerFriendlyName: object

serializedName

serializedName: string = "sourceProtectionContainerFriendlyName"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

targetFabricFriendlyName

targetFabricFriendlyName: object

serializedName

serializedName: string = "targetFabricFriendlyName"

type

type: object

name

name: "String" = "String"

targetProtectionContainerFriendlyName

targetProtectionContainerFriendlyName: object

serializedName

serializedName: string = "targetProtectionContainerFriendlyName"

type

type: object

name

name: "String" = "String"

targetProtectionContainerId

targetProtectionContainerId: object

serializedName

serializedName: string = "targetProtectionContainerId"

type

type: object

name

name: "String" = "String"

Const ProtectionContainerMappingProviderSpecificDetails

ProtectionContainerMappingProviderSpecificDetails: object
interface

An interface representing ProtectionContainerMappingProviderSpecificDetails. Container mapping provider specific details.

instanceType

instanceType: "ProtectionContainerMappingProviderSpecificDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ProtectionContainerMappingProviderSpecificDetails"

type

type: object

className

className: string = "ProtectionContainerMappingProviderSpecificDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProtectionContainerMappingProviderSpecificDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ProtectionContainerProperties

ProtectionContainerProperties: object
interface

An interface representing ProtectionContainerProperties. Protection profile custom data details.

Optional fabricFriendlyName

fabricFriendlyName: undefined | string
member

{string} [fabricFriendlyName] Fabric friendly name.

Optional fabricSpecificDetails

member

{ProtectionContainerFabricSpecificDetails} [fabricSpecificDetails] Fabric specific details.

Optional fabricType

fabricType: undefined | string
member

{string} [fabricType] The fabric type.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The name.

Optional pairingStatus

pairingStatus: undefined | string
member

{string} [pairingStatus] The pairing status of this cloud.

Optional protectedItemCount

protectedItemCount: undefined | number
member

{number} [protectedItemCount] Number of protected PEs

Optional role

role: undefined | string
member

{string} [role] The role of this cloud.

serializedName

serializedName: string = "ProtectionContainerProperties"

type

type: object

className

className: string = "ProtectionContainerProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fabricFriendlyName

fabricFriendlyName: object

serializedName

serializedName: string = "fabricFriendlyName"

type

type: object

name

name: "String" = "String"

fabricSpecificDetails

fabricSpecificDetails: object

serializedName

serializedName: string = "fabricSpecificDetails"

type

type: object

className

className: string = "ProtectionContainerFabricSpecificDetails"

name

name: "Composite" = "Composite"

fabricType

fabricType: object

serializedName

serializedName: string = "fabricType"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

pairingStatus

pairingStatus: object

serializedName

serializedName: string = "pairingStatus"

type

type: object

name

name: "String" = "String"

protectedItemCount

protectedItemCount: object

serializedName

serializedName: string = "protectedItemCount"

type

type: object

name

name: "Number" = "Number"

role

role: object

serializedName

serializedName: string = "role"

type

type: object

name

name: "String" = "String"

Const ProviderError

ProviderError: object
interface

An interface representing ProviderError. This class contains the error details per object.

Optional errorCode

errorCode: undefined | number
member

{number} [errorCode] The Error code.

Optional errorId

errorId: undefined | string
member

{string} [errorId] The Provider error Id.

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] The Error message.

Optional possibleCauses

possibleCauses: undefined | string
member

{string} [possibleCauses] The possible causes for the error.

Optional recommendedAction

recommendedAction: undefined | string
member

{string} [recommendedAction] The recommended action to resolve the error.

serializedName

serializedName: string = "ProviderError"

type

type: object

className

className: string = "ProviderError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "Number" = "Number"

errorId

errorId: object

serializedName

serializedName: string = "errorId"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

possibleCauses

possibleCauses: object

serializedName

serializedName: string = "possibleCauses"

type

type: object

name

name: "String" = "String"

recommendedAction

recommendedAction: object

serializedName

serializedName: string = "recommendedAction"

type

type: object

name

name: "String" = "String"

Const ProviderSpecificFailoverInput

ProviderSpecificFailoverInput: object
interface

An interface representing ProviderSpecificFailoverInput. Provider specific failover input.

instanceType

instanceType: "ProviderSpecificFailoverInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ProviderSpecificFailoverInput"

type

type: object

className

className: string = "ProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProviderSpecificFailoverInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ProviderSpecificRecoveryPointDetails

ProviderSpecificRecoveryPointDetails: object
interface

An interface representing ProviderSpecificRecoveryPointDetails. Replication provider specific recovery point details.

instanceType

instanceType: "ProviderSpecificRecoveryPointDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ProviderSpecificRecoveryPointDetails"

type

type: object

className

className: string = "ProviderSpecificRecoveryPointDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProviderSpecificRecoveryPointDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const RcmAzureMigrationPolicyDetails

RcmAzureMigrationPolicyDetails: object
interface

An interface representing RcmAzureMigrationPolicyDetails. RCM based Azure migration specific policy details.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency in minutes.

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency in minutes.

instanceType

instanceType: "RcmAzureMigration"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmSyncStatus

multiVmSyncStatus: MultiVmSyncStatus
member

{MultiVmSyncStatus} [multiVmSyncStatus] A value indicating whether multi-VM sync has to be enabled. Possible values include: 'Enabled', 'Disabled'

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "RcmAzureMigration"

type

type: object

className

className: string = "RcmAzureMigrationPolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

multiVmSyncStatus

multiVmSyncStatus: object

serializedName

serializedName: string = "multiVmSyncStatus"

type

type: object

name

name: "String" = "String"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const RecoveryPlan

RecoveryPlan: object
interface

An interface representing RecoveryPlan. Recovery plan details.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{RecoveryPlanProperties} [properties] The custom details.

serializedName

serializedName: string = "RecoveryPlan"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RecoveryPlan"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPlanProperties"

name

name: "Composite" = "Composite"

Const RecoveryPlanA2AFailoverInput

RecoveryPlanA2AFailoverInput: object
interface

An interface representing RecoveryPlanA2AFailoverInput. Recovery plan A2A failover input.

Optional cloudServiceCreationOption

cloudServiceCreationOption: undefined | string
member

{string} [cloudServiceCreationOption] A value indicating whether to use recovery cloud service for TFO or not.

instanceType

instanceType: "A2A"
member

{string} instanceType Polymorphic Discriminator

Optional multiVmSyncPointOption

multiVmSyncPointOption: MultiVmSyncPointOption
member

{MultiVmSyncPointOption} [multiVmSyncPointOption] A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover. Possible values include: 'UseMultiVmSyncRecoveryPoint', 'UsePerVmRecoveryPoint'

recoveryPointType

recoveryPointType: A2ARpRecoveryPointType
member

{A2ARpRecoveryPointType} recoveryPointType The recovery point type. Possible values include: 'Latest', 'LatestApplicationConsistent', 'LatestCrashConsistent', 'LatestProcessed'

serializedName

serializedName: string = "A2A"

type

type: object

className

className: string = "RecoveryPlanA2AFailoverInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanProviderSpecificFailoverInput"

modelProperties

modelProperties: object

cloudServiceCreationOption

cloudServiceCreationOption: object

serializedName

serializedName: string = "cloudServiceCreationOption"

type

type: object

name

name: "String" = "String"

multiVmSyncPointOption

multiVmSyncPointOption: object

serializedName

serializedName: string = "multiVmSyncPointOption"

type

type: object

name

name: "String" = "String"

recoveryPointType

recoveryPointType: object

required

required: true = true

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanAction

RecoveryPlanAction: object
interface

An interface representing RecoveryPlanAction. Recovery plan action details.

actionName

actionName: string
member

{string} actionName The action name.

customDetails

member

{RecoveryPlanActionDetailsUnion} customDetails The custom details.

failoverDirections

failoverDirections: PossibleOperationsDirections[]
member

{PossibleOperationsDirections[]} failoverDirections The list of failover directions.

failoverTypes

member

{ReplicationProtectedItemOperation[]} failoverTypes The list of failover types.

serializedName

serializedName: string = "RecoveryPlanAction"

type

type: object

className

className: string = "RecoveryPlanAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionName

actionName: object

required

required: true = true

serializedName

serializedName: string = "actionName"

type

type: object

name

name: "String" = "String"

customDetails

customDetails: object

required

required: true = true

serializedName

serializedName: string = "customDetails"

type

type: object

className

className: string = "RecoveryPlanActionDetails"

name

name: "Composite" = "Composite"

failoverDirections

failoverDirections: object

required

required: true = true

serializedName

serializedName: string = "failoverDirections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

failoverTypes

failoverTypes: object

required

required: true = true

serializedName

serializedName: string = "failoverTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RecoveryPlanActionDetails

RecoveryPlanActionDetails: object
interface

An interface representing RecoveryPlanActionDetails. Recovery plan action custom details.

instanceType

instanceType: "RecoveryPlanActionDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "RecoveryPlanActionDetails"

type

type: object

className

className: string = "RecoveryPlanActionDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RecoveryPlanActionDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const RecoveryPlanAutomationRunbookActionDetails

RecoveryPlanAutomationRunbookActionDetails: object
interface

An interface representing RecoveryPlanAutomationRunbookActionDetails. Recovery plan Automation runbook action details.

fabricLocation

member

{RecoveryPlanActionLocation} fabricLocation The fabric location. Possible values include: 'Primary', 'Recovery'

instanceType

instanceType: "AutomationRunbookActionDetails"
member

{string} instanceType Polymorphic Discriminator

Optional runbookId

runbookId: undefined | string
member

{string} [runbookId] The runbook ARM Id.

Optional timeout

timeout: undefined | string
member

{string} [timeout] The runbook timeout.

serializedName

serializedName: string = "AutomationRunbookActionDetails"

type

type: object

className

className: string = "RecoveryPlanAutomationRunbookActionDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanActionDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanActionDetails"

modelProperties

modelProperties: object

fabricLocation

fabricLocation: object

required

required: true = true

serializedName

serializedName: string = "fabricLocation"

type

type: object

name

name: "String" = "String"

runbookId

runbookId: object

serializedName

serializedName: string = "runbookId"

type

type: object

name

name: "String" = "String"

timeout

timeout: object

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanCollection

RecoveryPlanCollection: object
interface

An interface representing the RecoveryPlanCollection. Recovery plan collection details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "RecoveryPlanCollection"

__@iterator

  • Iterator

    Returns IterableIterator<RecoveryPlan>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecoveryPlan>[]

      Additional items to add to the end of array1.

    Returns RecoveryPlan[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecoveryPlan[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecoveryPlan]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecoveryPlan, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecoveryPlan

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecoveryPlan[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecoveryPlan[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecoveryPlan | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RecoveryPlan | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecoveryPlan, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecoveryPlan

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecoveryPlan, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecoveryPlan

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecoveryPlan, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecoveryPlan

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RecoveryPlan | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RecoveryPlan

  • Parameters

    Returns RecoveryPlan

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RecoveryPlan
  • reduceRight(callbackfn: function, initialValue: RecoveryPlan): RecoveryPlan
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RecoveryPlan

  • Parameters

    Returns RecoveryPlan

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns RecoveryPlan[]

shift

  • Removes the first element from an array and returns it.

    Returns RecoveryPlan | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecoveryPlan[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecoveryPlan[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecoveryPlan[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecoveryPlan[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecoveryPlan[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecoveryPlan[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RecoveryPlan>

type

type: object

className

className: string = "RecoveryPlanCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlan"

name

name: "Composite" = "Composite"

Const RecoveryPlanGroup

RecoveryPlanGroup: object
interface

An interface representing RecoveryPlanGroup. Recovery plan group details.

Optional endGroupActions

endGroupActions: RecoveryPlanAction[]
member

{RecoveryPlanAction[]} [endGroupActions] The end group actions.

groupType

member

{RecoveryPlanGroupType} groupType The group type. Possible values include: 'Shutdown', 'Boot', 'Failover'

Optional replicationProtectedItems

replicationProtectedItems: RecoveryPlanProtectedItem[]
member

{RecoveryPlanProtectedItem[]} [replicationProtectedItems] The list of protected items.

Optional startGroupActions

startGroupActions: RecoveryPlanAction[]
member

{RecoveryPlanAction[]} [startGroupActions] The start group actions.

serializedName

serializedName: string = "RecoveryPlanGroup"

type

type: object

className

className: string = "RecoveryPlanGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endGroupActions

endGroupActions: object

serializedName

serializedName: string = "endGroupActions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanAction"

name

name: "Composite" = "Composite"

groupType

groupType: object

required

required: true = true

serializedName

serializedName: string = "groupType"

type

type: object

name

name: "String" = "String"

replicationProtectedItems

replicationProtectedItems: object

serializedName

serializedName: string = "replicationProtectedItems"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanProtectedItem"

name

name: "Composite" = "Composite"

startGroupActions

startGroupActions: object

serializedName

serializedName: string = "startGroupActions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanAction"

name

name: "Composite" = "Composite"

Const RecoveryPlanGroupTaskDetails

RecoveryPlanGroupTaskDetails: object
interface

An interface representing RecoveryPlanGroupTaskDetails. This class represents the recovery plan group task.

Optional childTasks

childTasks: ASRTask[]
member

{ASRTask[]} [childTasks] The child tasks.

Optional groupId

groupId: undefined | string
member

{string} [groupId] The group identifier.

instanceType

instanceType: "RecoveryPlanGroupTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional name

name: undefined | string
member

{string} [name] The name.

Optional rpGroupType

rpGroupType: undefined | string
member

{string} [rpGroupType] The group type.

serializedName

serializedName: string = "RecoveryPlanGroupTaskDetails"

type

type: object

className

className: string = "RecoveryPlanGroupTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = GroupTaskDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "GroupTaskDetails"

modelProperties

modelProperties: object

groupId

groupId: object

serializedName

serializedName: string = "groupId"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

rpGroupType

rpGroupType: object

serializedName

serializedName: string = "rpGroupType"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanHyperVReplicaAzureFailbackInput

RecoveryPlanHyperVReplicaAzureFailbackInput: object
interface

An interface representing RecoveryPlanHyperVReplicaAzureFailbackInput. Recovery plan HVR Azure failback input.

dataSyncOption

dataSyncOption: DataSyncStatus
member

{DataSyncStatus} dataSyncOption The data sync option. Possible values include: 'ForDownTime', 'ForSynchronization'

instanceType

instanceType: "HyperVReplicaAzureFailback"
member

{string} instanceType Polymorphic Discriminator

recoveryVmCreationOption

recoveryVmCreationOption: AlternateLocationRecoveryOption
member

{AlternateLocationRecoveryOption} recoveryVmCreationOption The ALR option. Possible values include: 'CreateVmIfNotFound', 'NoAction'

serializedName

serializedName: string = "HyperVReplicaAzureFailback"

type

type: object

className

className: string = "RecoveryPlanHyperVReplicaAzureFailbackInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanProviderSpecificFailoverInput"

modelProperties

modelProperties: object

dataSyncOption

dataSyncOption: object

required

required: true = true

serializedName

serializedName: string = "dataSyncOption"

type

type: object

name

name: "String" = "String"

recoveryVmCreationOption

recoveryVmCreationOption: object

required

required: true = true

serializedName

serializedName: string = "recoveryVmCreationOption"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanHyperVReplicaAzureFailoverInput

RecoveryPlanHyperVReplicaAzureFailoverInput: object
interface

An interface representing RecoveryPlanHyperVReplicaAzureFailoverInput. Recovery plan HVR Azure failover input.

instanceType

instanceType: "HyperVReplicaAzure"
member

{string} instanceType Polymorphic Discriminator

Optional primaryKekCertificatePfx

primaryKekCertificatePfx: undefined | string
member

{string} [primaryKekCertificatePfx] The primary KEK certificate PFX.

Optional recoveryPointType

member

{HyperVReplicaAzureRpRecoveryPointType} [recoveryPointType] The recovery point type. Possible values include: 'Latest', 'LatestApplicationConsistent', 'LatestProcessed'

Optional secondaryKekCertificatePfx

secondaryKekCertificatePfx: undefined | string
member

{string} [secondaryKekCertificatePfx] The secondary KEK certificate PFX.

vaultLocation

vaultLocation: string
member

{string} vaultLocation The vault location.

serializedName

serializedName: string = "HyperVReplicaAzure"

type

type: object

className

className: string = "RecoveryPlanHyperVReplicaAzureFailoverInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanProviderSpecificFailoverInput"

modelProperties

modelProperties: object

primaryKekCertificatePfx

primaryKekCertificatePfx: object

serializedName

serializedName: string = "primaryKekCertificatePfx"

type

type: object

name

name: "String" = "String"

recoveryPointType

recoveryPointType: object

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

secondaryKekCertificatePfx

secondaryKekCertificatePfx: object

serializedName

serializedName: string = "secondaryKekCertificatePfx"

type

type: object

name

name: "String" = "String"

vaultLocation

vaultLocation: object

required

required: true = true

serializedName

serializedName: string = "vaultLocation"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanInMageAzureV2FailoverInput

RecoveryPlanInMageAzureV2FailoverInput: object
interface

An interface representing RecoveryPlanInMageAzureV2FailoverInput. Recovery plan InMageAzureV2 failover input.

instanceType

instanceType: "InMageAzureV2"
member

{string} instanceType Polymorphic Discriminator

recoveryPointType

recoveryPointType: InMageV2RpRecoveryPointType
member

{InMageV2RpRecoveryPointType} recoveryPointType The recovery point type. Possible values include: 'Latest', 'LatestApplicationConsistent', 'LatestCrashConsistent', 'LatestProcessed'

Optional useMultiVmSyncPoint

useMultiVmSyncPoint: undefined | string
member

{string} [useMultiVmSyncPoint] A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.

vaultLocation

vaultLocation: string
member

{string} vaultLocation The vault location.

serializedName

serializedName: string = "InMageAzureV2"

type

type: object

className

className: string = "RecoveryPlanInMageAzureV2FailoverInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanProviderSpecificFailoverInput"

modelProperties

modelProperties: object

recoveryPointType

recoveryPointType: object

required

required: true = true

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

useMultiVmSyncPoint

useMultiVmSyncPoint: object

serializedName

serializedName: string = "useMultiVmSyncPoint"

type

type: object

name

name: "String" = "String"

vaultLocation

vaultLocation: object

required

required: true = true

serializedName

serializedName: string = "vaultLocation"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanInMageFailoverInput

RecoveryPlanInMageFailoverInput: object
interface

An interface representing RecoveryPlanInMageFailoverInput. Recovery plan InMage failover input.

instanceType

instanceType: "InMage"
member

{string} instanceType Polymorphic Discriminator

recoveryPointType

recoveryPointType: RpInMageRecoveryPointType
member

{RpInMageRecoveryPointType} recoveryPointType The recovery point type. Possible values include: 'LatestTime', 'LatestTag', 'Custom'

serializedName

serializedName: string = "InMage"

type

type: object

className

className: string = "RecoveryPlanInMageFailoverInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanProviderSpecificFailoverInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanProviderSpecificFailoverInput"

modelProperties

modelProperties: object

recoveryPointType

recoveryPointType: object

required

required: true = true

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanManualActionDetails

RecoveryPlanManualActionDetails: object
interface

An interface representing RecoveryPlanManualActionDetails. Recovery plan manual action details.

Optional description

description: undefined | string
member

{string} [description] The manual action description.

instanceType

instanceType: "ManualActionDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ManualActionDetails"

type

type: object

className

className: string = "RecoveryPlanManualActionDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanActionDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanActionDetails"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanPlannedFailoverInput

RecoveryPlanPlannedFailoverInput: object
interface

An interface representing RecoveryPlanPlannedFailoverInput. Recovery plan planned failover input.

properties

member

{RecoveryPlanPlannedFailoverInputProperties} properties The recovery plan planned failover input properties.

serializedName

serializedName: string = "RecoveryPlanPlannedFailoverInput"

type

type: object

className

className: string = "RecoveryPlanPlannedFailoverInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPlanPlannedFailoverInputProperties"

name

name: "Composite" = "Composite"

Const RecoveryPlanPlannedFailoverInputProperties

RecoveryPlanPlannedFailoverInputProperties: object
interface

An interface representing RecoveryPlanPlannedFailoverInputProperties. Recovery plan planned failover input properties.

failoverDirection

failoverDirection: PossibleOperationsDirections
member

{PossibleOperationsDirections} failoverDirection The failover direction. Possible values include: 'PrimaryToRecovery', 'RecoveryToPrimary'

Optional providerSpecificDetails

member

{RecoveryPlanProviderSpecificFailoverInputUnion[]} [providerSpecificDetails] The provider specific properties.

serializedName

serializedName: string = "RecoveryPlanPlannedFailoverInputProperties"

type

type: object

className

className: string = "RecoveryPlanPlannedFailoverInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

required

required: true = true

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

Const RecoveryPlanProperties

RecoveryPlanProperties: object
interface

An interface representing RecoveryPlanProperties. Recovery plan custom details.

Optional allowedOperations

allowedOperations: string[]
member

{string[]} [allowedOperations] The list of allowed operations.

Optional currentScenario

currentScenario: CurrentScenarioDetails
member

{CurrentScenarioDetails} [currentScenario] The current scenario details.

Optional currentScenarioStatus

currentScenarioStatus: undefined | string
member

{string} [currentScenarioStatus] The recovery plan status.

Optional currentScenarioStatusDescription

currentScenarioStatusDescription: undefined | string
member

{string} [currentScenarioStatusDescription] The recovery plan status description.

Optional failoverDeploymentModel

failoverDeploymentModel: undefined | string
member

{string} [failoverDeploymentModel] The failover deployment model.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The friendly name.

Optional groups

member

{RecoveryPlanGroup[]} [groups] The recovery plan groups.

Optional lastPlannedFailoverTime

lastPlannedFailoverTime: Date
member

{Date} [lastPlannedFailoverTime] The start time of the last planned failover.

Optional lastTestFailoverTime

lastTestFailoverTime: Date
member

{Date} [lastTestFailoverTime] The start time of the last test failover.

Optional lastUnplannedFailoverTime

lastUnplannedFailoverTime: Date
member

{Date} [lastUnplannedFailoverTime] The start time of the last unplanned failover.

Optional primaryFabricFriendlyName

primaryFabricFriendlyName: undefined | string
member

{string} [primaryFabricFriendlyName] The primary fabric friendly name.

Optional primaryFabricId

primaryFabricId: undefined | string
member

{string} [primaryFabricId] The primary fabric Id.

Optional recoveryFabricFriendlyName

recoveryFabricFriendlyName: undefined | string
member

{string} [recoveryFabricFriendlyName] The recovery fabric friendly name.

Optional recoveryFabricId

recoveryFabricId: undefined | string
member

{string} [recoveryFabricId] The recovery fabric Id.

Optional replicationProviders

replicationProviders: string[]
member

{string[]} [replicationProviders] The list of replication providers.

serializedName

serializedName: string = "RecoveryPlanProperties"

type

type: object

className

className: string = "RecoveryPlanProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedOperations

allowedOperations: object

serializedName

serializedName: string = "allowedOperations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

currentScenario

currentScenario: object

serializedName

serializedName: string = "currentScenario"

type

type: object

className

className: string = "CurrentScenarioDetails"

name

name: "Composite" = "Composite"

currentScenarioStatus

currentScenarioStatus: object

serializedName

serializedName: string = "currentScenarioStatus"

type

type: object

name

name: "String" = "String"

currentScenarioStatusDescription

currentScenarioStatusDescription: object

serializedName

serializedName: string = "currentScenarioStatusDescription"

type

type: object

name

name: "String" = "String"

failoverDeploymentModel

failoverDeploymentModel: object

serializedName

serializedName: string = "failoverDeploymentModel"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

groups

groups: object

serializedName

serializedName: string = "groups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanGroup"

name

name: "Composite" = "Composite"

lastPlannedFailoverTime

lastPlannedFailoverTime: object

serializedName

serializedName: string = "lastPlannedFailoverTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastTestFailoverTime

lastTestFailoverTime: object

serializedName

serializedName: string = "lastTestFailoverTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastUnplannedFailoverTime

lastUnplannedFailoverTime: object

serializedName

serializedName: string = "lastUnplannedFailoverTime"

type

type: object

name

name: "DateTime" = "DateTime"

primaryFabricFriendlyName

primaryFabricFriendlyName: object

serializedName

serializedName: string = "primaryFabricFriendlyName"

type

type: object

name

name: "String" = "String"

primaryFabricId

primaryFabricId: object

serializedName

serializedName: string = "primaryFabricId"

type

type: object

name

name: "String" = "String"

recoveryFabricFriendlyName

recoveryFabricFriendlyName: object

serializedName

serializedName: string = "recoveryFabricFriendlyName"

type

type: object

name

name: "String" = "String"

recoveryFabricId

recoveryFabricId: object

serializedName

serializedName: string = "recoveryFabricId"

type

type: object

name

name: "String" = "String"

replicationProviders

replicationProviders: object

serializedName

serializedName: string = "replicationProviders"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RecoveryPlanProtectedItem

RecoveryPlanProtectedItem: object
interface

An interface representing RecoveryPlanProtectedItem. Recovery plan protected item.

Optional id

id: undefined | string
member

{string} [id] The ARM Id of the recovery plan protected item.

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] The virtual machine Id.

serializedName

serializedName: string = "RecoveryPlanProtectedItem"

type

type: object

className

className: string = "RecoveryPlanProtectedItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

virtualMachineId

virtualMachineId: object

serializedName

serializedName: string = "virtualMachineId"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanProviderSpecificFailoverInput

RecoveryPlanProviderSpecificFailoverInput: object
interface

An interface representing RecoveryPlanProviderSpecificFailoverInput. Recovery plan provider specific failover input base class.

instanceType

instanceType: "RecoveryPlanProviderSpecificFailoverInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "RecoveryPlanProviderSpecificFailoverInput"

type

type: object

className

className: string = "RecoveryPlanProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RecoveryPlanProviderSpecificFailoverInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const RecoveryPlanScriptActionDetails

RecoveryPlanScriptActionDetails: object
interface

An interface representing RecoveryPlanScriptActionDetails. Recovery plan script action details.

fabricLocation

member

{RecoveryPlanActionLocation} fabricLocation The fabric location. Possible values include: 'Primary', 'Recovery'

instanceType

instanceType: "ScriptActionDetails"
member

{string} instanceType Polymorphic Discriminator

path

path: string
member

{string} path The script path.

Optional timeout

timeout: undefined | string
member

{string} [timeout] The script timeout.

serializedName

serializedName: string = "ScriptActionDetails"

type

type: object

className

className: string = "RecoveryPlanScriptActionDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPlanActionDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPlanActionDetails"

modelProperties

modelProperties: object

fabricLocation

fabricLocation: object

required

required: true = true

serializedName

serializedName: string = "fabricLocation"

type

type: object

name

name: "String" = "String"

path

path: object

required

required: true = true

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

timeout

timeout: object

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanShutdownGroupTaskDetails

RecoveryPlanShutdownGroupTaskDetails: object
interface

An interface representing RecoveryPlanShutdownGroupTaskDetails. This class represents the recovery plan shutdown group task details.

Optional childTasks

childTasks: ASRTask[]
member

{ASRTask[]} [childTasks] The child tasks.

Optional groupId

groupId: undefined | string
member

{string} [groupId] The group identifier.

instanceType

instanceType: "RecoveryPlanShutdownGroupTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional name

name: undefined | string
member

{string} [name] The name.

Optional rpGroupType

rpGroupType: undefined | string
member

{string} [rpGroupType] The group type.

serializedName

serializedName: string = "RecoveryPlanShutdownGroupTaskDetails"

type

type: object

className

className: string = "RecoveryPlanShutdownGroupTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = GroupTaskDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "GroupTaskDetails"

modelProperties

modelProperties: object

groupId

groupId: object

serializedName

serializedName: string = "groupId"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

rpGroupType

rpGroupType: object

serializedName

serializedName: string = "rpGroupType"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanTestFailoverCleanupInput

RecoveryPlanTestFailoverCleanupInput: object
interface

An interface representing RecoveryPlanTestFailoverCleanupInput. Recovery plan test failover cleanup input.

properties

member

{RecoveryPlanTestFailoverCleanupInputProperties} properties The recovery plan test failover cleanup input properties.

serializedName

serializedName: string = "RecoveryPlanTestFailoverCleanupInput"

type

type: object

className

className: string = "RecoveryPlanTestFailoverCleanupInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPlanTestFailoverCleanupInputProperties"

name

name: "Composite" = "Composite"

Const RecoveryPlanTestFailoverCleanupInputProperties

RecoveryPlanTestFailoverCleanupInputProperties: object
interface

An interface representing RecoveryPlanTestFailoverCleanupInputProperties. Recovery plan test failover cleanup input properties.

Optional comments

comments: undefined | string
member

{string} [comments] The test failover cleanup comments.

serializedName

serializedName: string = "RecoveryPlanTestFailoverCleanupInputProperties"

type

type: object

className

className: string = "RecoveryPlanTestFailoverCleanupInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

comments

comments: object

serializedName

serializedName: string = "comments"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanTestFailoverInput

RecoveryPlanTestFailoverInput: object
interface

An interface representing RecoveryPlanTestFailoverInput. Recovery plan test failover input.

properties

member

{RecoveryPlanTestFailoverInputProperties} properties The recovery plan test failover input properties.

serializedName

serializedName: string = "RecoveryPlanTestFailoverInput"

type

type: object

className

className: string = "RecoveryPlanTestFailoverInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPlanTestFailoverInputProperties"

name

name: "Composite" = "Composite"

Const RecoveryPlanTestFailoverInputProperties

RecoveryPlanTestFailoverInputProperties: object
interface

An interface representing RecoveryPlanTestFailoverInputProperties. Recovery plan test failover input properties.

failoverDirection

failoverDirection: PossibleOperationsDirections
member

{PossibleOperationsDirections} failoverDirection The failover direction. Possible values include: 'PrimaryToRecovery', 'RecoveryToPrimary'

Optional networkId

networkId: undefined | string
member

{string} [networkId] The Id of the network to be used for test failover.

networkType

networkType: string
member

{string} networkType The network type to be used for test failover.

Optional providerSpecificDetails

member

{RecoveryPlanProviderSpecificFailoverInputUnion[]} [providerSpecificDetails] The provider specific properties.

Optional skipTestFailoverCleanup

skipTestFailoverCleanup: undefined | string
member

{string} [skipTestFailoverCleanup] A value indicating whether the test failover cleanup is to be skipped.

serializedName

serializedName: string = "RecoveryPlanTestFailoverInputProperties"

type

type: object

className

className: string = "RecoveryPlanTestFailoverInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

required

required: true = true

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

networkId

networkId: object

serializedName

serializedName: string = "networkId"

type

type: object

name

name: "String" = "String"

networkType

networkType: object

required

required: true = true

serializedName

serializedName: string = "networkType"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

skipTestFailoverCleanup

skipTestFailoverCleanup: object

serializedName

serializedName: string = "skipTestFailoverCleanup"

type

type: object

name

name: "String" = "String"

Const RecoveryPlanUnplannedFailoverInput

RecoveryPlanUnplannedFailoverInput: object
interface

An interface representing RecoveryPlanUnplannedFailoverInput. Recovery plan unplanned failover input.

properties

member

{RecoveryPlanUnplannedFailoverInputProperties} properties The recovery plan unplanned failover input properties.

serializedName

serializedName: string = "RecoveryPlanUnplannedFailoverInput"

type

type: object

className

className: string = "RecoveryPlanUnplannedFailoverInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPlanUnplannedFailoverInputProperties"

name

name: "Composite" = "Composite"

Const RecoveryPlanUnplannedFailoverInputProperties

RecoveryPlanUnplannedFailoverInputProperties: object
interface

An interface representing RecoveryPlanUnplannedFailoverInputProperties. Recovery plan unplanned failover input properties.

failoverDirection

failoverDirection: PossibleOperationsDirections
member

{PossibleOperationsDirections} failoverDirection The failover direction. Possible values include: 'PrimaryToRecovery', 'RecoveryToPrimary'

Optional providerSpecificDetails

member

{RecoveryPlanProviderSpecificFailoverInputUnion[]} [providerSpecificDetails] The provider specific properties.

sourceSiteOperations

sourceSiteOperations: SourceSiteOperations
member

{SourceSiteOperations} sourceSiteOperations A value indicating whether source site operations are required. Possible values include: 'Required', 'NotRequired'

serializedName

serializedName: string = "RecoveryPlanUnplannedFailoverInputProperties"

type

type: object

className

className: string = "RecoveryPlanUnplannedFailoverInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

required

required: true = true

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

sourceSiteOperations

sourceSiteOperations: object

required

required: true = true

serializedName

serializedName: string = "sourceSiteOperations"

type

type: object

name

name: "String" = "String"

Const RecoveryPoint

RecoveryPoint: object
interface

An interface representing RecoveryPoint. Base class representing a recovery point.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{RecoveryPointProperties} [properties] Recovery point related data.

serializedName

serializedName: string = "RecoveryPoint"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RecoveryPoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPointProperties"

name

name: "Composite" = "Composite"

Const RecoveryPointCollection

RecoveryPointCollection: object
interface

An interface representing the RecoveryPointCollection. Collection of recovery point details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "RecoveryPointCollection"

__@iterator

  • Iterator

    Returns IterableIterator<RecoveryPoint>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecoveryPoint>[]

      Additional items to add to the end of array1.

    Returns RecoveryPoint[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecoveryPoint[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecoveryPoint]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecoveryPoint, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecoveryPoint

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecoveryPoint[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecoveryPoint[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecoveryPoint | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RecoveryPoint | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecoveryPoint, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecoveryPoint

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecoveryPoint, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecoveryPoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecoveryPoint, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecoveryPoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RecoveryPoint | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RecoveryPoint

  • Parameters

    Returns RecoveryPoint

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RecoveryPoint

  • Parameters

    Returns RecoveryPoint

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns RecoveryPoint[]

shift

  • Removes the first element from an array and returns it.

    Returns RecoveryPoint | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecoveryPoint[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecoveryPoint[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecoveryPoint[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecoveryPoint[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecoveryPoint[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecoveryPoint[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RecoveryPoint>

type

type: object

className

className: string = "RecoveryPointCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPoint"

name

name: "Composite" = "Composite"

Const RecoveryPointProperties

RecoveryPointProperties: object
interface

An interface representing RecoveryPointProperties. Recovery point properties.

Optional providerSpecificDetails

member

{ProviderSpecificRecoveryPointDetailsUnion} [providerSpecificDetails] The provider specific details for the recovery point.

Optional recoveryPointTime

recoveryPointTime: Date
member

{Date} [recoveryPointTime] The recovery point time.

Optional recoveryPointType

recoveryPointType: undefined | string
member

{string} [recoveryPointType] The recovery point type: ApplicationConsistent, CrashConsistent.

serializedName

serializedName: string = "RecoveryPointProperties"

type

type: object

className

className: string = "RecoveryPointProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ProviderSpecificRecoveryPointDetails"

name

name: "Composite" = "Composite"

recoveryPointTime

recoveryPointTime: object

serializedName

serializedName: string = "recoveryPointTime"

type

type: object

name

name: "DateTime" = "DateTime"

recoveryPointType

recoveryPointType: object

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

Const RecoveryServicesProvider

RecoveryServicesProvider: object
interface

An interface representing RecoveryServicesProvider. Provider details.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{RecoveryServicesProviderProperties} [properties] Provider properties.

serializedName

serializedName: string = "RecoveryServicesProvider"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RecoveryServicesProvider"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryServicesProviderProperties"

name

name: "Composite" = "Composite"

Const RecoveryServicesProviderCollection

RecoveryServicesProviderCollection: object
interface

An interface representing the RecoveryServicesProviderCollection. Collection of providers.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "RecoveryServicesProviderCollection"

__@iterator

  • Iterator

    Returns IterableIterator<RecoveryServicesProvider>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns RecoveryServicesProvider[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecoveryServicesProvider[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecoveryServicesProvider]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecoveryServicesProvider

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecoveryServicesProvider[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecoveryServicesProvider[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecoveryServicesProvider | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RecoveryServicesProvider | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecoveryServicesProvider

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecoveryServicesProvider

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecoveryServicesProvider

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RecoveryServicesProvider | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns RecoveryServicesProvider[]

shift

  • Removes the first element from an array and returns it.

    Returns RecoveryServicesProvider | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecoveryServicesProvider[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecoveryServicesProvider[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecoveryServicesProvider[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecoveryServicesProvider[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RecoveryServicesProvider>

type

type: object

className

className: string = "RecoveryServicesProviderCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryServicesProvider"

name

name: "Composite" = "Composite"

Const RecoveryServicesProviderProperties

RecoveryServicesProviderProperties: object
interface

An interface representing RecoveryServicesProviderProperties. Recovery services provider properties.

Optional allowedScenarios

allowedScenarios: string[]
member

{string[]} [allowedScenarios] The scenarios allowed on this provider.

Optional connectionStatus

connectionStatus: undefined | string
member

{string} [connectionStatus] A value indicating whether DRA is responsive.

Optional draIdentifier

draIdentifier: undefined | string
member

{string} [draIdentifier] The DRA Id.

Optional fabricFriendlyName

fabricFriendlyName: undefined | string
member

{string} [fabricFriendlyName] The fabric friendly name.

Optional fabricType

fabricType: undefined | string
member

{string} [fabricType] Type of the site.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the DRA.

Optional healthErrorDetails

healthErrorDetails: HealthError[]
member

{HealthError[]} [healthErrorDetails] The recovery services provider health error details.

Optional identityDetails

identityDetails: IdentityInformation
member

{IdentityInformation} [identityDetails] The identity details.

Optional lastHeartBeat

lastHeartBeat: Date
member

{Date} [lastHeartBeat] Time when last heartbeat was sent by the DRA.

Optional protectedItemCount

protectedItemCount: undefined | number
member

{number} [protectedItemCount] Number of protected VMs currently managed by the DRA.

Optional providerVersion

providerVersion: undefined | string
member

{string} [providerVersion] The provider version.

Optional providerVersionDetails

providerVersionDetails: VersionDetails
member

{VersionDetails} [providerVersionDetails] The provider version details.

Optional providerVersionExpiryDate

providerVersionExpiryDate: Date
member

{Date} [providerVersionExpiryDate] Expiry date of the version.

Optional providerVersionState

providerVersionState: undefined | string
member

{string} [providerVersionState] DRA version status.

Optional serverVersion

serverVersion: undefined | string
member

{string} [serverVersion] The fabric provider.

serializedName

serializedName: string = "RecoveryServicesProviderProperties"

type

type: object

className

className: string = "RecoveryServicesProviderProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedScenarios

allowedScenarios: object

serializedName

serializedName: string = "allowedScenarios"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

connectionStatus

connectionStatus: object

serializedName

serializedName: string = "connectionStatus"

type

type: object

name

name: "String" = "String"

draIdentifier

draIdentifier: object

serializedName

serializedName: string = "draIdentifier"

type

type: object

name

name: "String" = "String"

fabricFriendlyName

fabricFriendlyName: object

serializedName

serializedName: string = "fabricFriendlyName"

type

type: object

name

name: "String" = "String"

fabricType

fabricType: object

serializedName

serializedName: string = "fabricType"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthErrorDetails

healthErrorDetails: object

serializedName

serializedName: string = "healthErrorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

identityDetails

identityDetails: object

serializedName

serializedName: string = "identityDetails"

type

type: object

className

className: string = "IdentityInformation"

name

name: "Composite" = "Composite"

lastHeartBeat

lastHeartBeat: object

serializedName

serializedName: string = "lastHeartBeat"

type

type: object

name

name: "DateTime" = "DateTime"

protectedItemCount

protectedItemCount: object

serializedName

serializedName: string = "protectedItemCount"

type

type: object

name

name: "Number" = "Number"

providerVersion

providerVersion: object

serializedName

serializedName: string = "providerVersion"

type

type: object

name

name: "String" = "String"

providerVersionDetails

providerVersionDetails: object

serializedName

serializedName: string = "providerVersionDetails"

type

type: object

className

className: string = "VersionDetails"

name

name: "Composite" = "Composite"

providerVersionExpiryDate

providerVersionExpiryDate: object

serializedName

serializedName: string = "providerVersionExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

providerVersionState

providerVersionState: object

serializedName

serializedName: string = "providerVersionState"

type

type: object

name

name: "String" = "String"

serverVersion

serverVersion: object

serializedName

serializedName: string = "serverVersion"

type

type: object

name

name: "String" = "String"

Const RemoveProtectionContainerMappingInput

RemoveProtectionContainerMappingInput: object
interface

An interface representing RemoveProtectionContainerMappingInput. Container unpairing input.

Optional properties

member

{RemoveProtectionContainerMappingInputProperties} [properties] Configure protection input properties.

serializedName

serializedName: string = "RemoveProtectionContainerMappingInput"

type

type: object

className

className: string = "RemoveProtectionContainerMappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RemoveProtectionContainerMappingInputProperties"

name

name: "Composite" = "Composite"

Const RemoveProtectionContainerMappingInputProperties

RemoveProtectionContainerMappingInputProperties: object
interface

An interface representing RemoveProtectionContainerMappingInputProperties. Unpairing input properties.

Optional providerSpecificInput

member

{ReplicationProviderContainerUnmappingInput} [providerSpecificInput] Provider specific input for unpairing.

serializedName

serializedName: string = "RemoveProtectionContainerMappingInputProperties"

type

type: object

className

className: string = "RemoveProtectionContainerMappingInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificInput

providerSpecificInput: object

serializedName

serializedName: string = "providerSpecificInput"

type

type: object

className

className: string = "ReplicationProviderContainerUnmappingInput"

name

name: "Composite" = "Composite"

Const RenewCertificateInput

RenewCertificateInput: object
interface

An interface representing RenewCertificateInput. Certificate renewal input.

Optional properties

member

{RenewCertificateInputProperties} [properties] Renew certificate input properties.

serializedName

serializedName: string = "RenewCertificateInput"

type

type: object

className

className: string = "RenewCertificateInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RenewCertificateInputProperties"

name

name: "Composite" = "Composite"

Const RenewCertificateInputProperties

RenewCertificateInputProperties: object
interface

An interface representing RenewCertificateInputProperties. Renew Certificate input properties.

Optional renewCertificateType

renewCertificateType: undefined | string
member

{string} [renewCertificateType] Renew certificate type.

serializedName

serializedName: string = "RenewCertificateInputProperties"

type

type: object

className

className: string = "RenewCertificateInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

renewCertificateType

renewCertificateType: object

serializedName

serializedName: string = "renewCertificateType"

type

type: object

name

name: "String" = "String"

Const ReplicationGroupDetails

ReplicationGroupDetails: object
interface

An interface representing ReplicationGroupDetails. Replication group details. This will be used in case of San and Wvr.

instanceType

instanceType: "ReplicationGroupDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ReplicationGroupDetails"

type

type: object

className

className: string = "ReplicationGroupDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ConfigurationSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ConfigurationSettings"

modelProperties

modelProperties: object

Const ReplicationProtectedItem

ReplicationProtectedItem: object
interface

An interface representing ReplicationProtectedItem. Replication protected item.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{ReplicationProtectedItemProperties} [properties] The custom data.

serializedName

serializedName: string = "ReplicationProtectedItem"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ReplicationProtectedItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ReplicationProtectedItemProperties"

name

name: "Composite" = "Composite"

Const ReplicationProtectedItemCollection

ReplicationProtectedItemCollection: object
interface

An interface representing the ReplicationProtectedItemCollection. Replication protected item collection.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "ReplicationProtectedItemCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ReplicationProtectedItem>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ReplicationProtectedItem[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ReplicationProtectedItem[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ReplicationProtectedItem]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ReplicationProtectedItem

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ReplicationProtectedItem[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ReplicationProtectedItem[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ReplicationProtectedItem | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ReplicationProtectedItem | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ReplicationProtectedItem

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ReplicationProtectedItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ReplicationProtectedItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ReplicationProtectedItem | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns ReplicationProtectedItem[]

shift

  • Removes the first element from an array and returns it.

    Returns ReplicationProtectedItem | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ReplicationProtectedItem[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ReplicationProtectedItem[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ReplicationProtectedItem[]

      Elements to insert into the array in place of the deleted elements.

    Returns ReplicationProtectedItem[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ReplicationProtectedItem>

type

type: object

className

className: string = "ReplicationProtectedItemCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReplicationProtectedItem"

name

name: "Composite" = "Composite"

Const ReplicationProtectedItemProperties

ReplicationProtectedItemProperties: object
interface

An interface representing ReplicationProtectedItemProperties. Replication protected item custom data details.

Optional activeLocation

activeLocation: undefined | string
member

{string} [activeLocation] The Current active location of the PE.

Optional allowedOperations

allowedOperations: string[]
member

{string[]} [allowedOperations] The allowed operations on the Replication protected item.

Optional currentScenario

currentScenario: CurrentScenarioDetails
member

{CurrentScenarioDetails} [currentScenario] The current scenario.

Optional failoverHealth

failoverHealth: undefined | string
member

{string} [failoverHealth] The consolidated failover health for the VM.

Optional failoverRecoveryPointId

failoverRecoveryPointId: undefined | string
member

{string} [failoverRecoveryPointId] The recovery point ARM Id to which the Vm was failed over.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The name.

Optional healthErrors

healthErrors: HealthError[]
member

{HealthError[]} [healthErrors] List of health errors.

Optional lastSuccessfulFailoverTime

lastSuccessfulFailoverTime: Date
member

{Date} [lastSuccessfulFailoverTime] The Last successful failover time.

Optional lastSuccessfulTestFailoverTime

lastSuccessfulTestFailoverTime: Date
member

{Date} [lastSuccessfulTestFailoverTime] The Last successful test failover time.

Optional policyFriendlyName

policyFriendlyName: undefined | string
member

{string} [policyFriendlyName] The name of Policy governing this PE.

Optional policyId

policyId: undefined | string
member

{string} [policyId] The ID of Policy governing this PE.

Optional primaryFabricFriendlyName

primaryFabricFriendlyName: undefined | string
member

{string} [primaryFabricFriendlyName] The friendly name of the primary fabric.

Optional primaryFabricProvider

primaryFabricProvider: undefined | string
member

{string} [primaryFabricProvider] The fabric provider of the primary fabric.

Optional primaryProtectionContainerFriendlyName

primaryProtectionContainerFriendlyName: undefined | string
member

{string} [primaryProtectionContainerFriendlyName] The name of primary protection container friendly name.

Optional protectableItemId

protectableItemId: undefined | string
member

{string} [protectableItemId] The protected item ARM Id.

Optional protectedItemType

protectedItemType: undefined | string
member

{string} [protectedItemType] The type of protected item type.

Optional protectionState

protectionState: undefined | string
member

{string} [protectionState] The protection status.

Optional protectionStateDescription

protectionStateDescription: undefined | string
member

{string} [protectionStateDescription] The protection state description.

Optional providerSpecificDetails

member

{ReplicationProviderSpecificSettingsUnion} [providerSpecificDetails] The Replication provider custom settings.

Optional recoveryContainerId

recoveryContainerId: undefined | string
member

{string} [recoveryContainerId] The recovery container Id.

Optional recoveryFabricFriendlyName

recoveryFabricFriendlyName: undefined | string
member

{string} [recoveryFabricFriendlyName] The friendly name of recovery fabric.

Optional recoveryFabricId

recoveryFabricId: undefined | string
member

{string} [recoveryFabricId] The Arm Id of recovery fabric.

Optional recoveryProtectionContainerFriendlyName

recoveryProtectionContainerFriendlyName: undefined | string
member

{string} [recoveryProtectionContainerFriendlyName] The name of recovery container friendly name.

Optional recoveryServicesProviderId

recoveryServicesProviderId: undefined | string
member

{string} [recoveryServicesProviderId] The recovery provider ARM Id.

Optional replicationHealth

replicationHealth: undefined | string
member

{string} [replicationHealth] The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.

Optional testFailoverState

testFailoverState: undefined | string
member

{string} [testFailoverState] The Test failover state.

Optional testFailoverStateDescription

testFailoverStateDescription: undefined | string
member

{string} [testFailoverStateDescription] The Test failover state description.

serializedName

serializedName: string = "ReplicationProtectedItemProperties"

type

type: object

className

className: string = "ReplicationProtectedItemProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activeLocation

activeLocation: object

serializedName

serializedName: string = "activeLocation"

type

type: object

name

name: "String" = "String"

allowedOperations

allowedOperations: object

serializedName

serializedName: string = "allowedOperations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

currentScenario

currentScenario: object

serializedName

serializedName: string = "currentScenario"

type

type: object

className

className: string = "CurrentScenarioDetails"

name

name: "Composite" = "Composite"

failoverHealth

failoverHealth: object

serializedName

serializedName: string = "failoverHealth"

type

type: object

name

name: "String" = "String"

failoverRecoveryPointId

failoverRecoveryPointId: object

serializedName

serializedName: string = "failoverRecoveryPointId"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthErrors

healthErrors: object

serializedName

serializedName: string = "healthErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

lastSuccessfulFailoverTime

lastSuccessfulFailoverTime: object

serializedName

serializedName: string = "lastSuccessfulFailoverTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastSuccessfulTestFailoverTime

lastSuccessfulTestFailoverTime: object

serializedName

serializedName: string = "lastSuccessfulTestFailoverTime"

type

type: object

name

name: "DateTime" = "DateTime"

policyFriendlyName

policyFriendlyName: object

serializedName

serializedName: string = "policyFriendlyName"

type

type: object

name

name: "String" = "String"

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

primaryFabricFriendlyName

primaryFabricFriendlyName: object

serializedName

serializedName: string = "primaryFabricFriendlyName"

type

type: object

name

name: "String" = "String"

primaryFabricProvider

primaryFabricProvider: object

serializedName

serializedName: string = "primaryFabricProvider"

type

type: object

name

name: "String" = "String"

primaryProtectionContainerFriendlyName

primaryProtectionContainerFriendlyName: object

serializedName

serializedName: string = "primaryProtectionContainerFriendlyName"

type

type: object

name

name: "String" = "String"

protectableItemId

protectableItemId: object

serializedName

serializedName: string = "protectableItemId"

type

type: object

name

name: "String" = "String"

protectedItemType

protectedItemType: object

serializedName

serializedName: string = "protectedItemType"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

protectionStateDescription

protectionStateDescription: object

serializedName

serializedName: string = "protectionStateDescription"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ReplicationProviderSpecificSettings"

name

name: "Composite" = "Composite"

recoveryContainerId

recoveryContainerId: object

serializedName

serializedName: string = "recoveryContainerId"

type

type: object

name

name: "String" = "String"

recoveryFabricFriendlyName

recoveryFabricFriendlyName: object

serializedName

serializedName: string = "recoveryFabricFriendlyName"

type

type: object

name

name: "String" = "String"

recoveryFabricId

recoveryFabricId: object

serializedName

serializedName: string = "recoveryFabricId"

type

type: object

name

name: "String" = "String"

recoveryProtectionContainerFriendlyName

recoveryProtectionContainerFriendlyName: object

serializedName

serializedName: string = "recoveryProtectionContainerFriendlyName"

type

type: object

name

name: "String" = "String"

recoveryServicesProviderId

recoveryServicesProviderId: object

serializedName

serializedName: string = "recoveryServicesProviderId"

type

type: object

name

name: "String" = "String"

replicationHealth

replicationHealth: object

serializedName

serializedName: string = "replicationHealth"

type

type: object

name

name: "String" = "String"

testFailoverState

testFailoverState: object

serializedName

serializedName: string = "testFailoverState"

type

type: object

name

name: "String" = "String"

testFailoverStateDescription

testFailoverStateDescription: object

serializedName

serializedName: string = "testFailoverStateDescription"

type

type: object

name

name: "String" = "String"

Const ReplicationProviderContainerUnmappingInput

ReplicationProviderContainerUnmappingInput: object
interface

An interface representing ReplicationProviderContainerUnmappingInput. Provider specific input for unpairing operations.

Optional instanceType

instanceType: undefined | string
member

{string} [instanceType] The class type.

serializedName

serializedName: string = "ReplicationProviderContainerUnmappingInput"

type

type: object

className

className: string = "ReplicationProviderContainerUnmappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceType

instanceType: object

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

Const ReplicationProviderSpecificContainerCreationInput

ReplicationProviderSpecificContainerCreationInput: object
interface

An interface representing ReplicationProviderSpecificContainerCreationInput. Provider specific input for container creation operation.

instanceType

instanceType: "ReplicationProviderSpecificContainerCreationInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ReplicationProviderSpecificContainerCreationInput"

type

type: object

className

className: string = "ReplicationProviderSpecificContainerCreationInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicationProviderSpecificContainerCreationInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ReplicationProviderSpecificContainerMappingInput

ReplicationProviderSpecificContainerMappingInput: object
interface

An interface representing ReplicationProviderSpecificContainerMappingInput. Provider specific input for pairing operations.

instanceType

instanceType: "ReplicationProviderSpecificContainerMappingInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ReplicationProviderSpecificContainerMappingInput"

type

type: object

className

className: string = "ReplicationProviderSpecificContainerMappingInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicationProviderSpecificContainerMappingInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ReplicationProviderSpecificSettings

ReplicationProviderSpecificSettings: object
interface

An interface representing ReplicationProviderSpecificSettings. Replication provider specific settings.

instanceType

instanceType: "ReplicationProviderSpecificSettings"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ReplicationProviderSpecificSettings"

type

type: object

className

className: string = "ReplicationProviderSpecificSettings"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicationProviderSpecificSettings"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const ReplicationProviderSpecificUpdateContainerMappingInput

ReplicationProviderSpecificUpdateContainerMappingInput: object
interface

An interface representing ReplicationProviderSpecificUpdateContainerMappingInput. Provider specific input for update pairing operations.

instanceType

instanceType: "ReplicationProviderSpecificUpdateContainerMappingInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ReplicationProviderSpecificUpdateContainerMappingInput"

type

type: object

className

className: string = "ReplicationProviderSpecificUpdateContainerMappingInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReplicationProviderSpecificUpdateContainerMappingInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const Resource

Resource: object
interface

An interface representing Resource. Azure resource.

extends

BaseResource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceHealthSummary

ResourceHealthSummary: object
interface

An interface representing ResourceHealthSummary. Base class to define the health summary of the resources contained under an Arm resource.

Optional issues

member

{HealthErrorSummary[]} [issues] The list of summary of health errors across the resources under the container.

Optional resourceCount

resourceCount: undefined | number
member

{number} [resourceCount] The count of total resources umder the container.

serializedName

serializedName: string = "ResourceHealthSummary"

type

type: object

className

className: string = "ResourceHealthSummary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

issues

issues: object

serializedName

serializedName: string = "issues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthErrorSummary"

name

name: "Composite" = "Composite"

resourceCount

resourceCount: object

serializedName

serializedName: string = "resourceCount"

type

type: object

name

name: "Number" = "Number"

Const ResumeJobParams

ResumeJobParams: object
interface

An interface representing ResumeJobParams. Resume job params.

Optional properties

member

{ResumeJobParamsProperties} [properties] Resume job properties.

serializedName

serializedName: string = "ResumeJobParams"

type

type: object

className

className: string = "ResumeJobParams"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ResumeJobParamsProperties"

name

name: "Composite" = "Composite"

Const ResumeJobParamsProperties

ResumeJobParamsProperties: object
interface

An interface representing ResumeJobParamsProperties. Resume job properties.

Optional comments

comments: undefined | string
member

{string} [comments] Resume job comments.

serializedName

serializedName: string = "ResumeJobParamsProperties"

type

type: object

className

className: string = "ResumeJobParamsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

comments

comments: object

serializedName

serializedName: string = "comments"

type

type: object

name

name: "String" = "String"

Const RetentionVolume

RetentionVolume: object
interface

An interface representing RetentionVolume. The retention details of the MT.

Optional capacityInBytes

capacityInBytes: undefined | number
member

{number} [capacityInBytes] The volume capacity.

Optional freeSpaceInBytes

freeSpaceInBytes: undefined | number
member

{number} [freeSpaceInBytes] The free space available in this volume.

Optional thresholdPercentage

thresholdPercentage: undefined | number
member

{number} [thresholdPercentage] The threshold percentage.

Optional volumeName

volumeName: undefined | string
member

{string} [volumeName] The volume name.

serializedName

serializedName: string = "RetentionVolume"

type

type: object

className

className: string = "RetentionVolume"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacityInBytes

capacityInBytes: object

serializedName

serializedName: string = "capacityInBytes"

type

type: object

name

name: "Number" = "Number"

freeSpaceInBytes

freeSpaceInBytes: object

serializedName

serializedName: string = "freeSpaceInBytes"

type

type: object

name

name: "Number" = "Number"

thresholdPercentage

thresholdPercentage: object

serializedName

serializedName: string = "thresholdPercentage"

type

type: object

name

name: "Number" = "Number"

volumeName

volumeName: object

serializedName

serializedName: string = "volumeName"

type

type: object

name

name: "String" = "String"

Const ReverseReplicationInput

ReverseReplicationInput: object
interface

An interface representing ReverseReplicationInput. Reverse replication input.

Optional properties

member

{ReverseReplicationInputProperties} [properties] Reverse replication properties

serializedName

serializedName: string = "ReverseReplicationInput"

type

type: object

className

className: string = "ReverseReplicationInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ReverseReplicationInputProperties"

name

name: "Composite" = "Composite"

Const ReverseReplicationInputProperties

ReverseReplicationInputProperties: object
interface

An interface representing ReverseReplicationInputProperties. Reverse replication input properties.

Optional failoverDirection

failoverDirection: undefined | string
member

{string} [failoverDirection] Failover direction.

Optional providerSpecificDetails

member

{ReverseReplicationProviderSpecificInputUnion} [providerSpecificDetails] Provider specific reverse replication input.

serializedName

serializedName: string = "ReverseReplicationInputProperties"

type

type: object

className

className: string = "ReverseReplicationInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ReverseReplicationProviderSpecificInput"

name

name: "Composite" = "Composite"

Const ReverseReplicationProviderSpecificInput

ReverseReplicationProviderSpecificInput: object
interface

An interface representing ReverseReplicationProviderSpecificInput. Provider specific reverse replication input.

instanceType

instanceType: "ReverseReplicationProviderSpecificInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "ReverseReplicationProviderSpecificInput"

type

type: object

className

className: string = "ReverseReplicationProviderSpecificInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ReverseReplicationProviderSpecificInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const RoleAssignment

RoleAssignment: object
interface

An interface representing RoleAssignment. Azure role assignment details.

Optional id

id: undefined | string
member

{string} [id] The ARM Id of the role assignment.

Optional name

name: undefined | string
member

{string} [name] The name of the role assignment.

Optional principalId

principalId: undefined | string
member

{string} [principalId] Principal Id.

Optional roleDefinitionId

roleDefinitionId: undefined | string
member

{string} [roleDefinitionId] Role definition id.

Optional scope

scope: undefined | string
member

{string} [scope] Role assignment scope.

serializedName

serializedName: string = "RoleAssignment"

type

type: object

className

className: string = "RoleAssignment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

roleDefinitionId

roleDefinitionId: object

serializedName

serializedName: string = "roleDefinitionId"

type

type: object

name

name: "String" = "String"

scope

scope: object

serializedName

serializedName: string = "scope"

type

type: object

name

name: "String" = "String"

Const RunAsAccount

RunAsAccount: object
interface

An interface representing RunAsAccount. CS Accounts Details.

Optional accountId

accountId: undefined | string
member

{string} [accountId] The CS RunAs account Id.

Optional accountName

accountName: undefined | string
member

{string} [accountName] The CS RunAs account name.

serializedName

serializedName: string = "RunAsAccount"

type

type: object

className

className: string = "RunAsAccount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accountId

accountId: object

serializedName

serializedName: string = "accountId"

type

type: object

name

name: "String" = "String"

accountName

accountName: object

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

Const SanEnableProtectionInput

SanEnableProtectionInput: object
interface

An interface representing SanEnableProtectionInput. San enable protection provider specific input.

instanceType

instanceType: "San"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "San"

type

type: object

className

className: string = "SanEnableProtectionInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = EnableProtectionProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "EnableProtectionProviderSpecificInput"

modelProperties

modelProperties: object

Const ScriptActionTaskDetails

ScriptActionTaskDetails: object
interface

An interface representing ScriptActionTaskDetails. This class represents the script action task details.

instanceType

instanceType: "ScriptActionTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional isPrimarySideScript

isPrimarySideScript: undefined | false | true
member

{boolean} [isPrimarySideScript] A value indicating whether it is a primary side script or not.

Optional name

name: undefined | string
member

{string} [name] The name.

Optional output

output: undefined | string
member

{string} [output] The output.

Optional path

path: undefined | string
member

{string} [path] The path.

serializedName

serializedName: string = "ScriptActionTaskDetails"

type

type: object

className

className: string = "ScriptActionTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

isPrimarySideScript

isPrimarySideScript: object

serializedName

serializedName: string = "isPrimarySideScript"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

output

output: object

serializedName

serializedName: string = "output"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

Const ServiceError

ServiceError: object
interface

An interface representing ServiceError. ASR error model

Optional activityId

activityId: undefined | string
member

{string} [activityId] Activity Id.

Optional code

code: undefined | string
member

{string} [code] Error code.

Optional message

message: undefined | string
member

{string} [message] Error message.

Optional possibleCauses

possibleCauses: undefined | string
member

{string} [possibleCauses] Possible causes of error.

Optional recommendedAction

recommendedAction: undefined | string
member

{string} [recommendedAction] Recommended action to resolve error.

serializedName

serializedName: string = "ServiceError"

type

type: object

className

className: string = "ServiceError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activityId

activityId: object

serializedName

serializedName: string = "activityId"

type

type: object

name

name: "String" = "String"

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

possibleCauses

possibleCauses: object

serializedName

serializedName: string = "possibleCauses"

type

type: object

name

name: "String" = "String"

recommendedAction

recommendedAction: object

serializedName

serializedName: string = "recommendedAction"

type

type: object

name

name: "String" = "String"

Const StorageClassification

StorageClassification: object
interface

An interface representing StorageClassification. Storage object definition.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{StorageClassificationProperties} [properties] Proprties of the storage object.

serializedName

serializedName: string = "StorageClassification"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "StorageClassification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "StorageClassificationProperties"

name

name: "Composite" = "Composite"

Const StorageClassificationCollection

StorageClassificationCollection: object
interface

An interface representing the StorageClassificationCollection. Collection of storage details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "StorageClassificationCollection"

__@iterator

  • Iterator

    Returns IterableIterator<StorageClassification>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns StorageClassification[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns StorageClassification[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, StorageClassification]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: StorageClassification

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): StorageClassification[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns StorageClassification[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): StorageClassification | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns StorageClassification | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: StorageClassification

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: StorageClassification

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: StorageClassification

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns StorageClassification | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StorageClassification

  • Parameters

    Returns StorageClassification

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns StorageClassification[]

shift

  • Removes the first element from an array and returns it.

    Returns StorageClassification | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns StorageClassification[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns StorageClassification[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: StorageClassification[]

      Elements to insert into the array in place of the deleted elements.

    Returns StorageClassification[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<StorageClassification>

type

type: object

className

className: string = "StorageClassificationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StorageClassification"

name

name: "Composite" = "Composite"

Const StorageClassificationMapping

StorageClassificationMapping: object
interface

An interface representing StorageClassificationMapping. Storage mapping object.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{StorageClassificationMappingProperties} [properties] Proprties of the storage mappping object.

serializedName

serializedName: string = "StorageClassificationMapping"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "StorageClassificationMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "StorageClassificationMappingProperties"

name

name: "Composite" = "Composite"

Const StorageClassificationMappingCollection

StorageClassificationMappingCollection: object
interface

An interface representing the StorageClassificationMappingCollection. Collection of storage mapping details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "StorageClassificationMappingCollection"

__@iterator

  • Iterator

    Returns IterableIterator<StorageClassificationMapping>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns StorageClassificationMapping[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns StorageClassificationMapping[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, StorageClassificationMapping]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: StorageClassificationMapping

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns StorageClassificationMapping[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): StorageClassificationMapping | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: StorageClassificationMapping

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: StorageClassificationMapping

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: StorageClassificationMapping

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns StorageClassificationMapping | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns StorageClassificationMapping[]

shift

  • Removes the first element from an array and returns it.

    Returns StorageClassificationMapping | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns StorageClassificationMapping[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns StorageClassificationMapping[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: StorageClassificationMapping[]

      Elements to insert into the array in place of the deleted elements.

    Returns StorageClassificationMapping[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<StorageClassificationMapping>

type

type: object

className

className: string = "StorageClassificationMappingCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StorageClassificationMapping"

name

name: "Composite" = "Composite"

Const StorageClassificationMappingInput

StorageClassificationMappingInput: object
interface

An interface representing StorageClassificationMappingInput. Storage mapping input.

Optional properties

member

{StorageMappingInputProperties} [properties] Storage mapping input properties.

serializedName

serializedName: string = "StorageClassificationMappingInput"

type

type: object

className

className: string = "StorageClassificationMappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "StorageMappingInputProperties"

name

name: "Composite" = "Composite"

Const StorageClassificationMappingProperties

StorageClassificationMappingProperties: object
interface

An interface representing StorageClassificationMappingProperties. Storage mapping properties.

Optional targetStorageClassificationId

targetStorageClassificationId: undefined | string
member

{string} [targetStorageClassificationId] Target storage object Id.

serializedName

serializedName: string = "StorageClassificationMappingProperties"

type

type: object

className

className: string = "StorageClassificationMappingProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetStorageClassificationId

targetStorageClassificationId: object

serializedName

serializedName: string = "targetStorageClassificationId"

type

type: object

name

name: "String" = "String"

Const StorageClassificationProperties

StorageClassificationProperties: object
interface

An interface representing StorageClassificationProperties. Storage object properties.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the Storage classification.

serializedName

serializedName: string = "StorageClassificationProperties"

type

type: object

className

className: string = "StorageClassificationProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

Const StorageMappingInputProperties

StorageMappingInputProperties: object
interface

An interface representing StorageMappingInputProperties. Storage mapping input properties.

Optional targetStorageClassificationId

targetStorageClassificationId: undefined | string
member

{string} [targetStorageClassificationId] The ID of the storage object.

serializedName

serializedName: string = "StorageMappingInputProperties"

type

type: object

className

className: string = "StorageMappingInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetStorageClassificationId

targetStorageClassificationId: object

serializedName

serializedName: string = "targetStorageClassificationId"

type

type: object

name

name: "String" = "String"

Const Subnet

Subnet: object
interface

An interface representing Subnet. Subnets of the network.

Optional addressList

addressList: string[]
member

{string[]} [addressList] The list of addresses for the subnet.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The subnet friendly name.

Optional name

name: undefined | string
member

{string} [name] The subnet name.

serializedName

serializedName: string = "Subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressList

addressList: object

serializedName

serializedName: string = "addressList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const SwitchProtectionInput

SwitchProtectionInput: object
interface

An interface representing SwitchProtectionInput. Switch protection input.

Optional properties

member

{SwitchProtectionInputProperties} [properties] Switch protection properties

serializedName

serializedName: string = "SwitchProtectionInput"

type

type: object

className

className: string = "SwitchProtectionInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "SwitchProtectionInputProperties"

name

name: "Composite" = "Composite"

Const SwitchProtectionInputProperties

SwitchProtectionInputProperties: object
interface

An interface representing SwitchProtectionInputProperties. Switch protection input properties.

Optional providerSpecificDetails

member

{SwitchProtectionProviderSpecificInputUnion} [providerSpecificDetails] Provider specific switch protection input.

Optional replicationProtectedItemName

replicationProtectedItemName: undefined | string
member

{string} [replicationProtectedItemName] The unique replication protected item name.

serializedName

serializedName: string = "SwitchProtectionInputProperties"

type

type: object

className

className: string = "SwitchProtectionInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "SwitchProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

replicationProtectedItemName

replicationProtectedItemName: object

serializedName

serializedName: string = "replicationProtectedItemName"

type

type: object

name

name: "String" = "String"

Const SwitchProtectionJobDetails

SwitchProtectionJobDetails: object
interface

An interface representing SwitchProtectionJobDetails. This class represents details for switch protection job.

Optional affectedObjectDetails

affectedObjectDetails: undefined | object
member

{{ [propertyName: string]: string }} [affectedObjectDetails] The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.

instanceType

instanceType: "SwitchProtectionJobDetails"
member

{string} instanceType Polymorphic Discriminator

Optional newReplicationProtectedItemId

newReplicationProtectedItemId: undefined | string
member

{string} [newReplicationProtectedItemId] ARM Id of the new replication protected item.

serializedName

serializedName: string = "SwitchProtectionJobDetails"

type

type: object

className

className: string = "SwitchProtectionJobDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobDetails"

modelProperties

modelProperties: object

newReplicationProtectedItemId

newReplicationProtectedItemId: object

serializedName

serializedName: string = "newReplicationProtectedItemId"

type

type: object

name

name: "String" = "String"

Const SwitchProtectionProviderSpecificInput

SwitchProtectionProviderSpecificInput: object
interface

An interface representing SwitchProtectionProviderSpecificInput. Provider specific switch protection input.

instanceType

instanceType: "SwitchProtectionProviderSpecificInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "SwitchProtectionProviderSpecificInput"

type

type: object

className

className: string = "SwitchProtectionProviderSpecificInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "SwitchProtectionProviderSpecificInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const TargetComputeSize

TargetComputeSize: object
interface

An interface representing TargetComputeSize. Represents applicable recovery vm sizes.

Optional id

id: undefined | string
member

{string} [id] The Id.

Optional name

name: undefined | string
member

{string} [name] The name.

Optional properties

member

{TargetComputeSizeProperties} [properties] The custom data.

serializedName

serializedName: string = "TargetComputeSize"

Optional type

type: object
member

{string} [type] The Type of the object.

className

className: string = "TargetComputeSize"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "TargetComputeSizeProperties"

name

name: "Composite" = "Composite"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const TargetComputeSizeCollection

TargetComputeSizeCollection: object
interface

An interface representing the TargetComputeSizeCollection. Target compute size collection.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "TargetComputeSizeCollection"

__@iterator

  • Iterator

    Returns IterableIterator<TargetComputeSize>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TargetComputeSize>[]

      Additional items to add to the end of array1.

    Returns TargetComputeSize[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TargetComputeSize[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TargetComputeSize]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TargetComputeSize, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TargetComputeSize

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TargetComputeSize[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TargetComputeSize[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TargetComputeSize | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns TargetComputeSize | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TargetComputeSize, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TargetComputeSize

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TargetComputeSize

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TargetComputeSize, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TargetComputeSize

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns TargetComputeSize | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TargetComputeSize

  • Parameters

    Returns TargetComputeSize

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TargetComputeSize

  • Parameters

    Returns TargetComputeSize

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns TargetComputeSize[]

shift

  • Removes the first element from an array and returns it.

    Returns TargetComputeSize | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TargetComputeSize[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TargetComputeSize[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TargetComputeSize[]

      Elements to insert into the array in place of the deleted elements.

    Returns TargetComputeSize[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<TargetComputeSize>

type

type: object

className

className: string = "TargetComputeSizeCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TargetComputeSize"

name

name: "Composite" = "Composite"

Const TargetComputeSizeProperties

TargetComputeSizeProperties: object
interface

An interface representing TargetComputeSizeProperties. Represents applicable recovery vm sizes properties.

Optional cpuCoresCount

cpuCoresCount: undefined | number
member

{number} [cpuCoresCount] The maximum cpu cores count supported by target compute size.

Optional errors

member

{ComputeSizeErrorDetails[]} [errors] The reasons why the target compute size is not applicable for the protected item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Target compute size display name.

Optional highIopsSupported

highIopsSupported: undefined | string
member

{string} [highIopsSupported] The value indicating whether the target compute size supports high Iops.

Optional maxDataDiskCount

maxDataDiskCount: undefined | number
member

{number} [maxDataDiskCount] The maximum data disks count supported by target compute size.

Optional maxNicsCount

maxNicsCount: undefined | number
member

{number} [maxNicsCount] The maximum Nics count supported by target compute size.

Optional memoryInGB

memoryInGB: undefined | number
member

{number} [memoryInGB] The maximum memory in GB supported by target compute size.

Optional name

name: undefined | string
member

{string} [name] Target compute size name.

serializedName

serializedName: string = "TargetComputeSizeProperties"

type

type: object

className

className: string = "TargetComputeSizeProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cpuCoresCount

cpuCoresCount: object

serializedName

serializedName: string = "cpuCoresCount"

type

type: object

name

name: "Number" = "Number"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeSizeErrorDetails"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

highIopsSupported

highIopsSupported: object

serializedName

serializedName: string = "highIopsSupported"

type

type: object

name

name: "String" = "String"

maxDataDiskCount

maxDataDiskCount: object

serializedName

serializedName: string = "maxDataDiskCount"

type

type: object

name

name: "Number" = "Number"

maxNicsCount

maxNicsCount: object

serializedName

serializedName: string = "maxNicsCount"

type

type: object

name

name: "Number" = "Number"

memoryInGB

memoryInGB: object

serializedName

serializedName: string = "memoryInGB"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const TaskTypeDetails

TaskTypeDetails: object
interface

An interface representing TaskTypeDetails. Task details based on specific task type.

instanceType

instanceType: "TaskTypeDetails"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "TaskTypeDetails"

type

type: object

className

className: string = "TaskTypeDetails"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const TestFailoverCleanupInput

TestFailoverCleanupInput: object
interface

An interface representing TestFailoverCleanupInput. Input definition for test failover cleanup.

properties

member

{TestFailoverCleanupInputProperties} properties Test failover cleanup input properties.

serializedName

serializedName: string = "TestFailoverCleanupInput"

type

type: object

className

className: string = "TestFailoverCleanupInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "TestFailoverCleanupInputProperties"

name

name: "Composite" = "Composite"

Const TestFailoverCleanupInputProperties

TestFailoverCleanupInputProperties: object
interface

An interface representing TestFailoverCleanupInputProperties. Input definition for test failover cleanup input properties.

Optional comments

comments: undefined | string
member

{string} [comments] Test failover cleanup comments.

serializedName

serializedName: string = "TestFailoverCleanupInputProperties"

type

type: object

className

className: string = "TestFailoverCleanupInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

comments

comments: object

serializedName

serializedName: string = "comments"

type

type: object

name

name: "String" = "String"

Const TestFailoverInput

TestFailoverInput: object
interface

An interface representing TestFailoverInput. Input definition for planned failover.

Optional properties

member

{TestFailoverInputProperties} [properties] Planned failover input properties

serializedName

serializedName: string = "TestFailoverInput"

type

type: object

className

className: string = "TestFailoverInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "TestFailoverInputProperties"

name

name: "Composite" = "Composite"

Const TestFailoverInputProperties

TestFailoverInputProperties: object
interface

An interface representing TestFailoverInputProperties. Input definition for planned failover input properties.

Optional failoverDirection

failoverDirection: undefined | string
member

{string} [failoverDirection] Failover direction.

Optional networkId

networkId: undefined | string
member

{string} [networkId] The id of the network to be used for test failover

Optional networkType

networkType: undefined | string
member

{string} [networkType] Network type to be used for test failover.

Optional providerSpecificDetails

providerSpecificDetails: ProviderSpecificFailoverInputUnion
member

{ProviderSpecificFailoverInputUnion} [providerSpecificDetails] Provider specific settings

Optional skipTestFailoverCleanup

skipTestFailoverCleanup: undefined | string
member

{string} [skipTestFailoverCleanup] A value indicating whether the test failover cleanup is to be skipped.

serializedName

serializedName: string = "TestFailoverInputProperties"

type

type: object

className

className: string = "TestFailoverInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

networkId

networkId: object

serializedName

serializedName: string = "networkId"

type

type: object

name

name: "String" = "String"

networkType

networkType: object

serializedName

serializedName: string = "networkType"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

skipTestFailoverCleanup

skipTestFailoverCleanup: object

serializedName

serializedName: string = "skipTestFailoverCleanup"

type

type: object

name

name: "String" = "String"

Const TestFailoverJobDetails

TestFailoverJobDetails: object
interface

An interface representing TestFailoverJobDetails. This class represents the details for a test failover job.

Optional affectedObjectDetails

affectedObjectDetails: undefined | object
member

{{ [propertyName: string]: string }} [affectedObjectDetails] The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.

Optional comments

comments: undefined | string
member

{string} [comments] The test failover comments.

instanceType

instanceType: "TestFailoverJobDetails"
member

{string} instanceType Polymorphic Discriminator

Optional networkFriendlyName

networkFriendlyName: undefined | string
member

{string} [networkFriendlyName] The test network friendly name.

Optional networkName

networkName: undefined | string
member

{string} [networkName] The test network name.

Optional networkType

networkType: undefined | string
member

{string} [networkType] The test network type (see TestFailoverInput enum for possible values).

Optional protectedItemDetails

member

{FailoverReplicationProtectedItemDetails[]} [protectedItemDetails] The test VM details.

Optional testFailoverStatus

testFailoverStatus: undefined | string
member

{string} [testFailoverStatus] The test failover status.

serializedName

serializedName: string = "TestFailoverJobDetails"

type

type: object

className

className: string = "TestFailoverJobDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobDetails"

modelProperties

modelProperties: object

comments

comments: object

serializedName

serializedName: string = "comments"

type

type: object

name

name: "String" = "String"

networkFriendlyName

networkFriendlyName: object

serializedName

serializedName: string = "networkFriendlyName"

type

type: object

name

name: "String" = "String"

networkName

networkName: object

serializedName

serializedName: string = "networkName"

type

type: object

name

name: "String" = "String"

networkType

networkType: object

serializedName

serializedName: string = "networkType"

type

type: object

name

name: "String" = "String"

protectedItemDetails

protectedItemDetails: object

serializedName

serializedName: string = "protectedItemDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FailoverReplicationProtectedItemDetails"

name

name: "Composite" = "Composite"

testFailoverStatus

testFailoverStatus: object

serializedName

serializedName: string = "testFailoverStatus"

type

type: object

name

name: "String" = "String"

Const UnplannedFailoverInput

UnplannedFailoverInput: object
interface

An interface representing UnplannedFailoverInput. Input definition for planned failover.

Optional properties

member

{UnplannedFailoverInputProperties} [properties] Planned failover input properties

serializedName

serializedName: string = "UnplannedFailoverInput"

type

type: object

className

className: string = "UnplannedFailoverInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UnplannedFailoverInputProperties"

name

name: "Composite" = "Composite"

Const UnplannedFailoverInputProperties

UnplannedFailoverInputProperties: object
interface

An interface representing UnplannedFailoverInputProperties. Input definition for planned failover input properties.

Optional failoverDirection

failoverDirection: undefined | string
member

{string} [failoverDirection] Failover direction.

Optional providerSpecificDetails

providerSpecificDetails: ProviderSpecificFailoverInputUnion
member

{ProviderSpecificFailoverInputUnion} [providerSpecificDetails] Provider specific settings

Optional sourceSiteOperations

sourceSiteOperations: undefined | string
member

{string} [sourceSiteOperations] Source site operations status

serializedName

serializedName: string = "UnplannedFailoverInputProperties"

type

type: object

className

className: string = "UnplannedFailoverInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failoverDirection

failoverDirection: object

serializedName

serializedName: string = "failoverDirection"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "ProviderSpecificFailoverInput"

name

name: "Composite" = "Composite"

sourceSiteOperations

sourceSiteOperations: object

serializedName

serializedName: string = "sourceSiteOperations"

type

type: object

name

name: "String" = "String"

Const UpdateMobilityServiceRequest

UpdateMobilityServiceRequest: object
interface

An interface representing UpdateMobilityServiceRequest. Request to update the mobility service on a protected item.

Optional properties

member

{UpdateMobilityServiceRequestProperties} [properties] The properties of the update mobility service request.

serializedName

serializedName: string = "UpdateMobilityServiceRequest"

type

type: object

className

className: string = "UpdateMobilityServiceRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdateMobilityServiceRequestProperties"

name

name: "Composite" = "Composite"

Const UpdateMobilityServiceRequestProperties

UpdateMobilityServiceRequestProperties: object
interface

An interface representing UpdateMobilityServiceRequestProperties. The properties of an update mobility service request.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The CS run as account Id.

serializedName

serializedName: string = "UpdateMobilityServiceRequestProperties"

type

type: object

className

className: string = "UpdateMobilityServiceRequestProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

Const UpdateNetworkMappingInput

UpdateNetworkMappingInput: object
interface

An interface representing UpdateNetworkMappingInput. Update network mapping input.

Optional properties

member

{UpdateNetworkMappingInputProperties} [properties] The input properties needed to update network mapping.

serializedName

serializedName: string = "UpdateNetworkMappingInput"

type

type: object

className

className: string = "UpdateNetworkMappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdateNetworkMappingInputProperties"

name

name: "Composite" = "Composite"

Const UpdateNetworkMappingInputProperties

UpdateNetworkMappingInputProperties: object
interface

An interface representing UpdateNetworkMappingInputProperties. Common input details for network mapping operation.

Optional fabricSpecificDetails

member

{FabricSpecificUpdateNetworkMappingInputUnion} [fabricSpecificDetails] Fabrics specific input network Id.

Optional recoveryFabricName

recoveryFabricName: undefined | string
member

{string} [recoveryFabricName] Recovery fabric name.

Optional recoveryNetworkId

recoveryNetworkId: undefined | string
member

{string} [recoveryNetworkId] Recovery network Id.

serializedName

serializedName: string = "UpdateNetworkMappingInputProperties"

type

type: object

className

className: string = "UpdateNetworkMappingInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fabricSpecificDetails

fabricSpecificDetails: object

serializedName

serializedName: string = "fabricSpecificDetails"

type

type: object

className

className: string = "FabricSpecificUpdateNetworkMappingInput"

name

name: "Composite" = "Composite"

recoveryFabricName

recoveryFabricName: object

serializedName

serializedName: string = "recoveryFabricName"

type

type: object

name

name: "String" = "String"

recoveryNetworkId

recoveryNetworkId: object

serializedName

serializedName: string = "recoveryNetworkId"

type

type: object

name

name: "String" = "String"

Const UpdatePolicyInput

UpdatePolicyInput: object
interface

An interface representing UpdatePolicyInput. Update policy input.

Optional properties

member

{UpdatePolicyInputProperties} [properties] The ReplicationProviderSettings.

serializedName

serializedName: string = "UpdatePolicyInput"

type

type: object

className

className: string = "UpdatePolicyInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdatePolicyInputProperties"

name

name: "Composite" = "Composite"

Const UpdatePolicyInputProperties

UpdatePolicyInputProperties: object
interface

An interface representing UpdatePolicyInputProperties. Policy update properties.

Optional replicationProviderSettings

replicationProviderSettings: PolicyProviderSpecificInputUnion
member

{PolicyProviderSpecificInputUnion} [replicationProviderSettings] The ReplicationProviderSettings.

serializedName

serializedName: string = "UpdatePolicyInputProperties"

type

type: object

className

className: string = "UpdatePolicyInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

replicationProviderSettings

replicationProviderSettings: object

serializedName

serializedName: string = "replicationProviderSettings"

type

type: object

className

className: string = "PolicyProviderSpecificInput"

name

name: "Composite" = "Composite"

Const UpdateProtectionContainerMappingInput

UpdateProtectionContainerMappingInput: object
interface

An interface representing UpdateProtectionContainerMappingInput. Container pairing update input.

Optional properties

member

{UpdateProtectionContainerMappingInputProperties} [properties] Update protection container mapping input properties.

serializedName

serializedName: string = "UpdateProtectionContainerMappingInput"

type

type: object

className

className: string = "UpdateProtectionContainerMappingInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdateProtectionContainerMappingInputProperties"

name

name: "Composite" = "Composite"

Const UpdateProtectionContainerMappingInputProperties

UpdateProtectionContainerMappingInputProperties: object
interface

An interface representing UpdateProtectionContainerMappingInputProperties. Container pairing update input.

Optional providerSpecificInput

member

{ReplicationProviderSpecificUpdateContainerMappingInputUnion} [providerSpecificInput] Provider specific input for updating protection container mapping.

serializedName

serializedName: string = "UpdateProtectionContainerMappingInputProperties"

type

type: object

className

className: string = "UpdateProtectionContainerMappingInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerSpecificInput

providerSpecificInput: object

serializedName

serializedName: string = "providerSpecificInput"

type

type: object

className

className: string = "ReplicationProviderSpecificUpdateContainerMappingInput"

name

name: "Composite" = "Composite"

Const UpdateRecoveryPlanInput

UpdateRecoveryPlanInput: object
interface

An interface representing UpdateRecoveryPlanInput. Update recovery plan input class.

Optional properties

member

{UpdateRecoveryPlanInputProperties} [properties] Recovery plan update properties.

serializedName

serializedName: string = "UpdateRecoveryPlanInput"

type

type: object

className

className: string = "UpdateRecoveryPlanInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdateRecoveryPlanInputProperties"

name

name: "Composite" = "Composite"

Const UpdateRecoveryPlanInputProperties

UpdateRecoveryPlanInputProperties: object
interface

An interface representing UpdateRecoveryPlanInputProperties. Recovery plan updation properties.

Optional groups

member

{RecoveryPlanGroup[]} [groups] The recovery plan groups.

serializedName

serializedName: string = "UpdateRecoveryPlanInputProperties"

type

type: object

className

className: string = "UpdateRecoveryPlanInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

groups

groups: object

serializedName

serializedName: string = "groups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPlanGroup"

name

name: "Composite" = "Composite"

Const UpdateReplicationProtectedItemInput

UpdateReplicationProtectedItemInput: object
interface

An interface representing UpdateReplicationProtectedItemInput. Update replication protected item input.

Optional properties

member

{UpdateReplicationProtectedItemInputProperties} [properties] Update replication protected item properties.

serializedName

serializedName: string = "UpdateReplicationProtectedItemInput"

type

type: object

className

className: string = "UpdateReplicationProtectedItemInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdateReplicationProtectedItemInputProperties"

name

name: "Composite" = "Composite"

Const UpdateReplicationProtectedItemInputProperties

UpdateReplicationProtectedItemInputProperties: object
interface

An interface representing UpdateReplicationProtectedItemInputProperties. Update protected item input properties.

Optional enableRdpOnTargetOption

enableRdpOnTargetOption: undefined | string
member

{string} [enableRdpOnTargetOption] The selected option to enable RDP\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.

Optional licenseType

licenseType: LicenseType
member

{LicenseType} [licenseType] License type. Possible values include: 'NotSpecified', 'NoLicenseType', 'WindowsServer'

Optional providerSpecificDetails

member

{UpdateReplicationProtectedItemProviderInputUnion} [providerSpecificDetails] The provider specific input to update replication protected item.

Optional recoveryAvailabilitySetId

recoveryAvailabilitySetId: undefined | string
member

{string} [recoveryAvailabilitySetId] The target availability set id.

Optional recoveryAzureVMName

recoveryAzureVMName: undefined | string
member

{string} [recoveryAzureVMName] Target azure VM name given by the user.

Optional recoveryAzureVMSize

recoveryAzureVMSize: undefined | string
member

{string} [recoveryAzureVMSize] Target Azure Vm size.

Optional selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: undefined | string
member

{string} [selectedRecoveryAzureNetworkId] Target Azure Network Id.

Optional selectedSourceNicId

selectedSourceNicId: undefined | string
member

{string} [selectedSourceNicId] The selected source nic Id which will be used as the primary nic during failover.

Optional vmNics

member

{VMNicInputDetails[]} [vmNics] The list of vm nic details.

serializedName

serializedName: string = "UpdateReplicationProtectedItemInputProperties"

type

type: object

className

className: string = "UpdateReplicationProtectedItemInputProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enableRdpOnTargetOption

enableRdpOnTargetOption: object

serializedName

serializedName: string = "enableRdpOnTargetOption"

type

type: object

name

name: "String" = "String"

licenseType

licenseType: object

serializedName

serializedName: string = "licenseType"

type

type: object

name

name: "String" = "String"

providerSpecificDetails

providerSpecificDetails: object

serializedName

serializedName: string = "providerSpecificDetails"

type

type: object

className

className: string = "UpdateReplicationProtectedItemProviderInput"

name

name: "Composite" = "Composite"

recoveryAvailabilitySetId

recoveryAvailabilitySetId: object

serializedName

serializedName: string = "recoveryAvailabilitySetId"

type

type: object

name

name: "String" = "String"

recoveryAzureVMName

recoveryAzureVMName: object

serializedName

serializedName: string = "recoveryAzureVMName"

type

type: object

name

name: "String" = "String"

recoveryAzureVMSize

recoveryAzureVMSize: object

serializedName

serializedName: string = "recoveryAzureVMSize"

type

type: object

name

name: "String" = "String"

selectedRecoveryAzureNetworkId

selectedRecoveryAzureNetworkId: object

serializedName

serializedName: string = "selectedRecoveryAzureNetworkId"

type

type: object

name

name: "String" = "String"

selectedSourceNicId

selectedSourceNicId: object

serializedName

serializedName: string = "selectedSourceNicId"

type

type: object

name

name: "String" = "String"

vmNics

vmNics: object

serializedName

serializedName: string = "vmNics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VMNicInputDetails"

name

name: "Composite" = "Composite"

Const UpdateReplicationProtectedItemProviderInput

UpdateReplicationProtectedItemProviderInput: object
interface

An interface representing UpdateReplicationProtectedItemProviderInput. Update replication protected item provider specific input.

instanceType

instanceType: "UpdateReplicationProtectedItemProviderInput"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "UpdateReplicationProtectedItemProviderInput"

type

type: object

className

className: string = "UpdateReplicationProtectedItemProviderInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "UpdateReplicationProtectedItemProviderInput"

modelProperties

modelProperties: object

instanceType

instanceType: object

required

required: true = true

serializedName

serializedName: string = "instanceType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "instanceType"

serializedName

serializedName: string = "instanceType"

Const UpdateVCenterRequest

UpdateVCenterRequest: object
interface

An interface representing UpdateVCenterRequest. Input required to update vCenter.

Optional properties

member

{UpdateVCenterRequestProperties} [properties] The update VCenter Request Properties.

serializedName

serializedName: string = "UpdateVCenterRequest"

type

type: object

className

className: string = "UpdateVCenterRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "UpdateVCenterRequestProperties"

name

name: "Composite" = "Composite"

Const UpdateVCenterRequestProperties

UpdateVCenterRequestProperties: object
interface

An interface representing UpdateVCenterRequestProperties. The properties of an update vCenter request.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The friendly name of the vCenter.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of the vCenter to be discovered.

Optional port

port: undefined | string
member

{string} [port] The port number for discovery.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The process server Id from where the update can be orchestrated.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The CS account Id which has priviliges to update the vCenter.

serializedName

serializedName: string = "UpdateVCenterRequestProperties"

type

type: object

className

className: string = "UpdateVCenterRequestProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

Const VCenter

VCenter: object
interface

An interface representing VCenter. vCenter definition.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: VCenterProperties
member

{VCenterProperties} [properties] VCenter related data.

serializedName

serializedName: string = "VCenter"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "VCenter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "VCenterProperties"

name

name: "Composite" = "Composite"

Const VCenterCollection

VCenterCollection: object
interface

An interface representing the VCenterCollection. Collection of vCenter details.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The value of next link.

serializedName

serializedName: string = "VCenterCollection"

__@iterator

  • __@iterator(): IterableIterator<VCenter>
  • Iterator

    Returns IterableIterator<VCenter>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VCenter>[]): VCenter[]
  • concat(...items: (T | ConcatArray<T>)[]): VCenter[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VCenter>[]

      Additional items to add to the end of array1.

    Returns VCenter[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VCenter[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VCenter]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VCenter]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VCenter, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VCenter

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VCenter[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VCenter[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VCenter | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VCenter, index: number, obj: VCenter[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns VCenter | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VCenter, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VCenter

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VCenter, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VCenter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VCenter, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VCenter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns VCenter | undefined

push

  • push(...items: VCenter[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VCenter[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VCenter
  • reduce(callbackfn: function, initialValue: VCenter): VCenter
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns VCenter

  • Parameters

    Returns VCenter

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VCenter, currentIndex: number, array: VCenter[]): U
        • Parameters

          • previousValue: U
          • currentValue: VCenter
          • currentIndex: number
          • array: VCenter[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VCenter
  • reduceRight(callbackfn: function, initialValue: VCenter): VCenter
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns VCenter

  • Parameters

    Returns VCenter

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VCenter, currentIndex: number, array: VCenter[]): U
        • Parameters

          • previousValue: U
          • currentValue: VCenter
          • currentIndex: number
          • array: VCenter[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns VCenter[]

shift

  • Removes the first element from an array and returns it.

    Returns VCenter | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VCenter[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VCenter[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VCenter[]
  • splice(start: number, deleteCount: number, ...items: VCenter[]): VCenter[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VCenter[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VCenter[]

      Elements to insert into the array in place of the deleted elements.

    Returns VCenter[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VCenter[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VCenter[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VCenter>
  • Returns an iterable of values in the array

    Returns IterableIterator<VCenter>

type

type: object

className

className: string = "VCenterCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VCenter"

name

name: "Composite" = "Composite"

Const VCenterProperties

VCenterProperties: object
interface

An interface representing VCenterProperties. vCenter properties.

Optional discoveryStatus

discoveryStatus: undefined | string
member

{string} [discoveryStatus] The VCenter discovery status.

Optional fabricArmResourceName

fabricArmResourceName: undefined | string
member

{string} [fabricArmResourceName] The ARM resource name of the fabric containing this VCenter.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the vCenter.

Optional healthErrors

healthErrors: HealthError[]
member

{HealthError[]} [healthErrors] The health errors for this VCenter.

Optional infrastructureId

infrastructureId: undefined | string
member

{string} [infrastructureId] The infrastructure Id of vCenter.

Optional internalId

internalId: undefined | string
member

{string} [internalId] VCenter internal ID.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of the vCenter.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The time when the last heartbeat was reveived by vCenter.

Optional port

port: undefined | string
member

{string} [port] The port number for discovery.

Optional processServerId

processServerId: undefined | string
member

{string} [processServerId] The process server Id.

Optional runAsAccountId

runAsAccountId: undefined | string
member

{string} [runAsAccountId] The account Id which has privileges to discover the vCenter.

serializedName

serializedName: string = "VCenterProperties"

type

type: object

className

className: string = "VCenterProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

discoveryStatus

discoveryStatus: object

serializedName

serializedName: string = "discoveryStatus"

type

type: object

name

name: "String" = "String"

fabricArmResourceName

fabricArmResourceName: object

serializedName

serializedName: string = "fabricArmResourceName"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthErrors

healthErrors: object

serializedName

serializedName: string = "healthErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

infrastructureId

infrastructureId: object

serializedName

serializedName: string = "infrastructureId"

type

type: object

name

name: "String" = "String"

internalId

internalId: object

serializedName

serializedName: string = "internalId"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

port

port: object

serializedName

serializedName: string = "port"

type

type: object

name

name: "String" = "String"

processServerId

processServerId: object

serializedName

serializedName: string = "processServerId"

type

type: object

name

name: "String" = "String"

runAsAccountId

runAsAccountId: object

serializedName

serializedName: string = "runAsAccountId"

type

type: object

name

name: "String" = "String"

Const VMNicDetails

VMNicDetails: object
interface

An interface representing VMNicDetails. Hyper V VM network details.

Optional enableAcceleratedNetworkingOnRecovery

enableAcceleratedNetworkingOnRecovery: undefined | false | true
member

{boolean} [enableAcceleratedNetworkingOnRecovery] A value indicating whether the NIC has accerated networking enabled.

Optional ipAddressType

ipAddressType: undefined | string
member

{string} [ipAddressType] Ip address type.

Optional nicId

nicId: undefined | string
member

{string} [nicId] The nic Id.

Optional primaryNicStaticIPAddress

primaryNicStaticIPAddress: undefined | string
member

{string} [primaryNicStaticIPAddress] Primary nic static IP address.

Optional recoveryNicIpAddressType

recoveryNicIpAddressType: undefined | string
member

{string} [recoveryNicIpAddressType] IP allocation type for recovery VM.

Optional recoveryVMNetworkId

recoveryVMNetworkId: undefined | string
member

{string} [recoveryVMNetworkId] Recovery VM network Id.

Optional recoveryVMSubnetName

recoveryVMSubnetName: undefined | string
member

{string} [recoveryVMSubnetName] Recovery VM subnet name.

Optional replicaNicId

replicaNicId: undefined | string
member

{string} [replicaNicId] The replica nic Id.

Optional replicaNicStaticIPAddress

replicaNicStaticIPAddress: undefined | string
member

{string} [replicaNicStaticIPAddress] Replica nic static IP address.

Optional selectionType

selectionType: undefined | string
member

{string} [selectionType] Selection type for failover.

Optional sourceNicArmId

sourceNicArmId: undefined | string
member

{string} [sourceNicArmId] The source nic ARM Id.

Optional vMNetworkName

vMNetworkName: undefined | string
member

{string} [vMNetworkName] VM network name.

Optional vMSubnetName

vMSubnetName: undefined | string
member

{string} [vMSubnetName] VM subnet name.

serializedName

serializedName: string = "VMNicDetails"

type

type: object

className

className: string = "VMNicDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enableAcceleratedNetworkingOnRecovery

enableAcceleratedNetworkingOnRecovery: object

serializedName

serializedName: string = "enableAcceleratedNetworkingOnRecovery"

type

type: object

name

name: "Boolean" = "Boolean"

ipAddressType

ipAddressType: object

serializedName

serializedName: string = "ipAddressType"

type

type: object

name

name: "String" = "String"

nicId

nicId: object

serializedName

serializedName: string = "nicId"

type

type: object

name

name: "String" = "String"

primaryNicStaticIPAddress

primaryNicStaticIPAddress: object

serializedName

serializedName: string = "primaryNicStaticIPAddress"

type

type: object

name

name: "String" = "String"

recoveryNicIpAddressType

recoveryNicIpAddressType: object

serializedName

serializedName: string = "recoveryNicIpAddressType"

type

type: object

name

name: "String" = "String"

recoveryVMNetworkId

recoveryVMNetworkId: object

serializedName

serializedName: string = "recoveryVMNetworkId"

type

type: object

name

name: "String" = "String"

recoveryVMSubnetName

recoveryVMSubnetName: object

serializedName

serializedName: string = "recoveryVMSubnetName"

type

type: object

name

name: "String" = "String"

replicaNicId

replicaNicId: object

serializedName

serializedName: string = "replicaNicId"

type

type: object

name

name: "String" = "String"

replicaNicStaticIPAddress

replicaNicStaticIPAddress: object

serializedName

serializedName: string = "replicaNicStaticIPAddress"

type

type: object

name

name: "String" = "String"

selectionType

selectionType: object

serializedName

serializedName: string = "selectionType"

type

type: object

name

name: "String" = "String"

sourceNicArmId

sourceNicArmId: object

serializedName

serializedName: string = "sourceNicArmId"

type

type: object

name

name: "String" = "String"

vMNetworkName

vMNetworkName: object

serializedName

serializedName: string = "vMNetworkName"

type

type: object

name

name: "String" = "String"

vMSubnetName

vMSubnetName: object

serializedName

serializedName: string = "vMSubnetName"

type

type: object

name

name: "String" = "String"

Const VMNicInputDetails

VMNicInputDetails: object
interface

An interface representing VMNicInputDetails. Hyper V VM network input details.

Optional enableAcceleratedNetworkingOnRecovery

enableAcceleratedNetworkingOnRecovery: undefined | false | true
member

{boolean} [enableAcceleratedNetworkingOnRecovery] Whether the NIC has accerated networking enabled.

Optional nicId

nicId: undefined | string
member

{string} [nicId] The nic Id.

Optional recoveryVMSubnetName

recoveryVMSubnetName: undefined | string
member

{string} [recoveryVMSubnetName] Recovery VM subnet name.

Optional replicaNicStaticIPAddress

replicaNicStaticIPAddress: undefined | string
member

{string} [replicaNicStaticIPAddress] Replica nic static IP address.

Optional selectionType

selectionType: undefined | string
member

{string} [selectionType] Selection type for failover.

serializedName

serializedName: string = "VMNicInputDetails"

type

type: object

className

className: string = "VMNicInputDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enableAcceleratedNetworkingOnRecovery

enableAcceleratedNetworkingOnRecovery: object

serializedName

serializedName: string = "enableAcceleratedNetworkingOnRecovery"

type

type: object

name

name: "Boolean" = "Boolean"

nicId

nicId: object

serializedName

serializedName: string = "nicId"

type

type: object

name

name: "String" = "String"

recoveryVMSubnetName

recoveryVMSubnetName: object

serializedName

serializedName: string = "recoveryVMSubnetName"

type

type: object

name

name: "String" = "String"

replicaNicStaticIPAddress

replicaNicStaticIPAddress: object

serializedName

serializedName: string = "replicaNicStaticIPAddress"

type

type: object

name

name: "String" = "String"

selectionType

selectionType: object

serializedName

serializedName: string = "selectionType"

type

type: object

name

name: "String" = "String"

Const VMwareCbtPolicyCreationInput

VMwareCbtPolicyCreationInput: object
interface

An interface representing VMwareCbtPolicyCreationInput. VMware Cbt Policy creation input.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency (in minutes).

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency (in minutes).

instanceType

instanceType: "VMwareCbt"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

serializedName

serializedName: string = "VMwareCbt"

type

type: object

className

className: string = "VMwareCbtPolicyCreationInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificInput"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

Const VMwareDetails

VMwareDetails: object
interface

An interface representing VMwareDetails. Store the fabric details specific to the VMware fabric.

Optional agentCount

agentCount: undefined | string
member

{string} [agentCount] The number of source and target servers configured to talk to this CS.

Optional agentExpiryDate

agentExpiryDate: Date
member

{Date} [agentExpiryDate] Agent expiry date.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The agent Version.

Optional agentVersionDetails

agentVersionDetails: VersionDetails
member

{VersionDetails} [agentVersionDetails] The agent version details.

Optional availableMemoryInBytes

availableMemoryInBytes: undefined | number
member

{number} [availableMemoryInBytes] The available memory.

Optional availableSpaceInBytes

availableSpaceInBytes: undefined | number
member

{number} [availableSpaceInBytes] The available space.

Optional cpuLoad

cpuLoad: undefined | string
member

{string} [cpuLoad] The percentage of the CPU load.

Optional cpuLoadStatus

cpuLoadStatus: undefined | string
member

{string} [cpuLoadStatus] The CPU load status.

Optional csServiceStatus

csServiceStatus: undefined | string
member

{string} [csServiceStatus] The CS service status.

Optional databaseServerLoad

databaseServerLoad: undefined | string
member

{string} [databaseServerLoad] The database server load.

Optional databaseServerLoadStatus

databaseServerLoadStatus: undefined | string
member

{string} [databaseServerLoadStatus] The database server load status.

Optional hostName

hostName: undefined | string
member

{string} [hostName] The host name.

instanceType

instanceType: "VMware"
member

{string} instanceType Polymorphic Discriminator

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address.

Optional lastHeartbeat

lastHeartbeat: Date
member

{Date} [lastHeartbeat] The last heartbeat received from CS server.

Optional masterTargetServers

masterTargetServers: MasterTargetServer[]
member

{MasterTargetServer[]} [masterTargetServers] The list of Master Target servers associated with the fabric.

Optional memoryUsageStatus

memoryUsageStatus: undefined | string
member

{string} [memoryUsageStatus] The memory usage status.

Optional processServerCount

processServerCount: undefined | string
member

{string} [processServerCount] The number of process servers.

Optional processServers

processServers: ProcessServer[]
member

{ProcessServer[]} [processServers] The list of Process Servers associated with the fabric.

Optional protectedServers

protectedServers: undefined | string
member

{string} [protectedServers] The number of protected servers.

Optional psTemplateVersion

psTemplateVersion: undefined | string
member

{string} [psTemplateVersion] PS template version.

Optional replicationPairCount

replicationPairCount: undefined | string
member

{string} [replicationPairCount] The number of replication pairs configured in this CS.

Optional runAsAccounts

runAsAccounts: RunAsAccount[]
member

{RunAsAccount[]} [runAsAccounts] The list of run as accounts created on the server.

Optional spaceUsageStatus

spaceUsageStatus: undefined | string
member

{string} [spaceUsageStatus] The space usage status.

Optional sslCertExpiryDate

sslCertExpiryDate: Date
member

{Date} [sslCertExpiryDate] CS SSL cert expiry date.

Optional sslCertExpiryRemainingDays

sslCertExpiryRemainingDays: undefined | number
member

{number} [sslCertExpiryRemainingDays] CS SSL cert expiry date.

Optional systemLoad

systemLoad: undefined | string
member

{string} [systemLoad] The percentage of the system load.

Optional systemLoadStatus

systemLoadStatus: undefined | string
member

{string} [systemLoadStatus] The system load status.

Optional totalMemoryInBytes

totalMemoryInBytes: undefined | number
member

{number} [totalMemoryInBytes] The total memory.

Optional totalSpaceInBytes

totalSpaceInBytes: undefined | number
member

{number} [totalSpaceInBytes] The total space.

Optional versionStatus

versionStatus: undefined | string
member

{string} [versionStatus] Version status

Optional webLoad

webLoad: undefined | string
member

{string} [webLoad] The web load.

Optional webLoadStatus

webLoadStatus: undefined | string
member

{string} [webLoadStatus] The web load status.

serializedName

serializedName: string = "VMware"

type

type: object

className

className: string = "VMwareDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificDetails"

modelProperties

modelProperties: object

agentCount

agentCount: object

serializedName

serializedName: string = "agentCount"

type

type: object

name

name: "String" = "String"

agentExpiryDate

agentExpiryDate: object

serializedName

serializedName: string = "agentExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

agentVersionDetails

agentVersionDetails: object

serializedName

serializedName: string = "agentVersionDetails"

type

type: object

className

className: string = "VersionDetails"

name

name: "Composite" = "Composite"

availableMemoryInBytes

availableMemoryInBytes: object

serializedName

serializedName: string = "availableMemoryInBytes"

type

type: object

name

name: "Number" = "Number"

availableSpaceInBytes

availableSpaceInBytes: object

serializedName

serializedName: string = "availableSpaceInBytes"

type

type: object

name

name: "Number" = "Number"

cpuLoad

cpuLoad: object

serializedName

serializedName: string = "cpuLoad"

type

type: object

name

name: "String" = "String"

cpuLoadStatus

cpuLoadStatus: object

serializedName

serializedName: string = "cpuLoadStatus"

type

type: object

name

name: "String" = "String"

csServiceStatus

csServiceStatus: object

serializedName

serializedName: string = "csServiceStatus"

type

type: object

name

name: "String" = "String"

databaseServerLoad

databaseServerLoad: object

serializedName

serializedName: string = "databaseServerLoad"

type

type: object

name

name: "String" = "String"

databaseServerLoadStatus

databaseServerLoadStatus: object

serializedName

serializedName: string = "databaseServerLoadStatus"

type

type: object

name

name: "String" = "String"

hostName

hostName: object

serializedName

serializedName: string = "hostName"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

lastHeartbeat

lastHeartbeat: object

serializedName

serializedName: string = "lastHeartbeat"

type

type: object

name

name: "DateTime" = "DateTime"

masterTargetServers

masterTargetServers: object

serializedName

serializedName: string = "masterTargetServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MasterTargetServer"

name

name: "Composite" = "Composite"

memoryUsageStatus

memoryUsageStatus: object

serializedName

serializedName: string = "memoryUsageStatus"

type

type: object

name

name: "String" = "String"

processServerCount

processServerCount: object

serializedName

serializedName: string = "processServerCount"

type

type: object

name

name: "String" = "String"

processServers

processServers: object

serializedName

serializedName: string = "processServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProcessServer"

name

name: "Composite" = "Composite"

protectedServers

protectedServers: object

serializedName

serializedName: string = "protectedServers"

type

type: object

name

name: "String" = "String"

psTemplateVersion

psTemplateVersion: object

serializedName

serializedName: string = "psTemplateVersion"

type

type: object

name

name: "String" = "String"

replicationPairCount

replicationPairCount: object

serializedName

serializedName: string = "replicationPairCount"

type

type: object

name

name: "String" = "String"

runAsAccounts

runAsAccounts: object

serializedName

serializedName: string = "runAsAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RunAsAccount"

name

name: "Composite" = "Composite"

spaceUsageStatus

spaceUsageStatus: object

serializedName

serializedName: string = "spaceUsageStatus"

type

type: object

name

name: "String" = "String"

sslCertExpiryDate

sslCertExpiryDate: object

serializedName

serializedName: string = "sslCertExpiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

sslCertExpiryRemainingDays

sslCertExpiryRemainingDays: object

serializedName

serializedName: string = "sslCertExpiryRemainingDays"

type

type: object

name

name: "Number" = "Number"

systemLoad

systemLoad: object

serializedName

serializedName: string = "systemLoad"

type

type: object

name

name: "String" = "String"

systemLoadStatus

systemLoadStatus: object

serializedName

serializedName: string = "systemLoadStatus"

type

type: object

name

name: "String" = "String"

totalMemoryInBytes

totalMemoryInBytes: object

serializedName

serializedName: string = "totalMemoryInBytes"

type

type: object

name

name: "Number" = "Number"

totalSpaceInBytes

totalSpaceInBytes: object

serializedName

serializedName: string = "totalSpaceInBytes"

type

type: object

name

name: "Number" = "Number"

versionStatus

versionStatus: object

serializedName

serializedName: string = "versionStatus"

type

type: object

name

name: "String" = "String"

webLoad

webLoad: object

serializedName

serializedName: string = "webLoad"

type

type: object

name

name: "String" = "String"

webLoadStatus

webLoadStatus: object

serializedName

serializedName: string = "webLoadStatus"

type

type: object

name

name: "String" = "String"

Const VMwareV2FabricCreationInput

VMwareV2FabricCreationInput: object
interface

An interface representing VMwareV2FabricCreationInput. Fabric provider specific settings.

instanceType

instanceType: "VMwareV2"
member

{string} instanceType Polymorphic Discriminator

Optional keyVaultResourceArmId

keyVaultResourceArmId: undefined | string
member

{string} [keyVaultResourceArmId] The Key Vault ARM Id.

Optional keyVaultUrl

keyVaultUrl: undefined | string
member

{string} [keyVaultUrl] The Key Vault URL.

serializedName

serializedName: string = "VMwareV2"

type

type: object

className

className: string = "VMwareV2FabricCreationInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificCreationInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificCreationInput"

modelProperties

modelProperties: object

keyVaultResourceArmId

keyVaultResourceArmId: object

serializedName

serializedName: string = "keyVaultResourceArmId"

type

type: object

name

name: "String" = "String"

keyVaultUrl

keyVaultUrl: object

serializedName

serializedName: string = "keyVaultUrl"

type

type: object

name

name: "String" = "String"

Const VMwareV2FabricSpecificDetails

VMwareV2FabricSpecificDetails: object
interface

An interface representing VMwareV2FabricSpecificDetails. VMwareV2 fabric Specific Details.

instanceType

instanceType: "VMwareV2"
member

{string} instanceType Polymorphic Discriminator

Optional keyVaultResourceArmId

keyVaultResourceArmId: undefined | string
member

{string} [keyVaultResourceArmId] The Key Vault ARM Id.

Optional keyVaultUrl

keyVaultUrl: undefined | string
member

{string} [keyVaultUrl] The Key Vault URL.

Optional rcmServiceEndpoint

rcmServiceEndpoint: undefined | string
member

{string} [rcmServiceEndpoint] The endpoint for making requests to the RCM Service.

Optional srsServiceEndpoint

srsServiceEndpoint: undefined | string
member

{string} [srsServiceEndpoint] The endpoint for making requests to the SRS Service.

serializedName

serializedName: string = "VMwareV2"

type

type: object

className

className: string = "VMwareV2FabricSpecificDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificDetails"

modelProperties

modelProperties: object

keyVaultResourceArmId

keyVaultResourceArmId: object

serializedName

serializedName: string = "keyVaultResourceArmId"

type

type: object

name

name: "String" = "String"

keyVaultUrl

keyVaultUrl: object

serializedName

serializedName: string = "keyVaultUrl"

type

type: object

name

name: "String" = "String"

rcmServiceEndpoint

rcmServiceEndpoint: object

serializedName

serializedName: string = "rcmServiceEndpoint"

type

type: object

name

name: "String" = "String"

srsServiceEndpoint

srsServiceEndpoint: object

serializedName

serializedName: string = "srsServiceEndpoint"

type

type: object

name

name: "String" = "String"

Const VMwareVirtualMachineDetails

VMwareVirtualMachineDetails: object
interface

An interface representing VMwareVirtualMachineDetails. VMware provider specific settings

Optional agentGeneratedId

agentGeneratedId: undefined | string
member

{string} [agentGeneratedId] The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection.

Optional agentInstalled

agentInstalled: undefined | string
member

{string} [agentInstalled] The value indicating if InMage scout agent is installed on guest.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] The agent version.

Optional discoveryType

discoveryType: undefined | string
member

{string} [discoveryType] A value inidicating the discovery type of the machine. Value can be vCenter or physical.

Optional diskDetails

diskDetails: InMageDiskDetails[]
member

{InMageDiskDetails[]} [diskDetails] The disk details.

instanceType

instanceType: "VMwareVirtualMachine"
member

{string} instanceType Polymorphic Discriminator

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address.

Optional osType

osType: undefined | string
member

{string} [osType] The OsType installed on VM.

Optional poweredOn

poweredOn: undefined | string
member

{string} [poweredOn] The value indicating whether VM is powered on.

Optional vCenterInfrastructureId

vCenterInfrastructureId: undefined | string
member

{string} [vCenterInfrastructureId] The VCenter infrastructure Id.

Optional validationErrors

validationErrors: HealthError[]
member

{HealthError[]} [validationErrors] The validation errors.

serializedName

serializedName: string = "VMwareVirtualMachine"

type

type: object

className

className: string = "VMwareVirtualMachineDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ConfigurationSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ConfigurationSettings"

modelProperties

modelProperties: object

agentGeneratedId

agentGeneratedId: object

serializedName

serializedName: string = "agentGeneratedId"

type

type: object

name

name: "String" = "String"

agentInstalled

agentInstalled: object

serializedName

serializedName: string = "agentInstalled"

type

type: object

name

name: "String" = "String"

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

discoveryType

discoveryType: object

serializedName

serializedName: string = "discoveryType"

type

type: object

name

name: "String" = "String"

diskDetails

diskDetails: object

serializedName

serializedName: string = "diskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InMageDiskDetails"

name

name: "Composite" = "Composite"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

poweredOn

poweredOn: object

serializedName

serializedName: string = "poweredOn"

type

type: object

name

name: "String" = "String"

vCenterInfrastructureId

vCenterInfrastructureId: object

serializedName

serializedName: string = "vCenterInfrastructureId"

type

type: object

name

name: "String" = "String"

validationErrors

validationErrors: object

serializedName

serializedName: string = "validationErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

Const VaultHealthDetails

VaultHealthDetails: object
interface

An interface representing VaultHealthDetails. Vault health details definition.

extends

Resource

Optional id

id: undefined | string
member

{string} [id] Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource Location

Optional name

name: undefined | string
member

{string} [name] Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

member

{VaultHealthProperties} [properties] The vault health related data.

serializedName

serializedName: string = "VaultHealthDetails"

Optional type

type: object
member

{string} [type] Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "VaultHealthDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "VaultHealthProperties"

name

name: "Composite" = "Composite"

Const VaultHealthProperties

VaultHealthProperties: object
interface

An interface representing VaultHealthProperties. class to define the health summary of the Vault.

Optional containersHealth

containersHealth: ResourceHealthSummary
member

{ResourceHealthSummary} [containersHealth] The list of the health detail of the containers in the vault.

Optional fabricsHealth

fabricsHealth: ResourceHealthSummary
member

{ResourceHealthSummary} [fabricsHealth] The list of the health detail of the fabrics in the vault.

Optional protectedItemsHealth

protectedItemsHealth: ResourceHealthSummary
member

{ResourceHealthSummary} [protectedItemsHealth] The list of the health detail of the protected items in the vault.

Optional vaultErrors

vaultErrors: HealthError[]
member

{HealthError[]} [vaultErrors] The list of errors on the vault.

serializedName

serializedName: string = "VaultHealthProperties"

type

type: object

className

className: string = "VaultHealthProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containersHealth

containersHealth: object

serializedName

serializedName: string = "containersHealth"

type

type: object

className

className: string = "ResourceHealthSummary"

name

name: "Composite" = "Composite"

fabricsHealth

fabricsHealth: object

serializedName

serializedName: string = "fabricsHealth"

type

type: object

className

className: string = "ResourceHealthSummary"

name

name: "Composite" = "Composite"

protectedItemsHealth

protectedItemsHealth: object

serializedName

serializedName: string = "protectedItemsHealth"

type

type: object

className

className: string = "ResourceHealthSummary"

name

name: "Composite" = "Composite"

vaultErrors

vaultErrors: object

serializedName

serializedName: string = "vaultErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthError"

name

name: "Composite" = "Composite"

Const VersionDetails

VersionDetails: object
interface

An interface representing VersionDetails. Version related details.

Optional expiryDate

expiryDate: Date
member

{Date} [expiryDate] Version expiry date.

Optional status

member

{AgentVersionStatus} [status] A value indicating whether security update required. Possible values include: 'Supported', 'NotSupported', 'Deprecated', 'UpdateRequired', 'SecurityUpdateRequired'

Optional version

version: undefined | string
member

{string} [version] The agent version.

serializedName

serializedName: string = "VersionDetails"

type

type: object

className

className: string = "VersionDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryDate

expiryDate: object

serializedName

serializedName: string = "expiryDate"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const VirtualMachineTaskDetails

VirtualMachineTaskDetails: object
interface

An interface representing VirtualMachineTaskDetails. This class represents the virtual machine task details.

instanceType

instanceType: "VirtualMachineTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional jobTask

jobTask: JobEntity
member

{JobEntity} [jobTask] The job entity.

Optional skippedReason

skippedReason: undefined | string
member

{string} [skippedReason] The skipped reason.

Optional skippedReasonString

skippedReasonString: undefined | string
member

{string} [skippedReasonString] The skipped reason string.

serializedName

serializedName: string = "VirtualMachineTaskDetails"

type

type: object

className

className: string = "VirtualMachineTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

jobTask

jobTask: object

serializedName

serializedName: string = "jobTask"

type

type: object

className

className: string = "JobEntity"

name

name: "Composite" = "Composite"

skippedReason

skippedReason: object

serializedName

serializedName: string = "skippedReason"

type

type: object

name

name: "String" = "String"

skippedReasonString

skippedReasonString: object

serializedName

serializedName: string = "skippedReasonString"

type

type: object

name

name: "String" = "String"

Const VmNicUpdatesTaskDetails

VmNicUpdatesTaskDetails: object
interface

An interface representing VmNicUpdatesTaskDetails. This class represents the vm NicUpdates task details.

instanceType

instanceType: "VmNicUpdatesTaskDetails"
member

{string} instanceType Polymorphic Discriminator

Optional name

name: undefined | string
member

{string} [name] Name of the Nic.

Optional nicId

nicId: undefined | string
member

{string} [nicId] Nic Id.

Optional vmId

vmId: undefined | string
member

{string} [vmId] Virtual machine Id.

serializedName

serializedName: string = "VmNicUpdatesTaskDetails"

type

type: object

className

className: string = "VmNicUpdatesTaskDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = TaskTypeDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "TaskTypeDetails"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nicId

nicId: object

serializedName

serializedName: string = "nicId"

type

type: object

name

name: "String" = "String"

vmId

vmId: object

serializedName

serializedName: string = "vmId"

type

type: object

name

name: "String" = "String"

Const VmmDetails

VmmDetails: object
interface

An interface representing VmmDetails. VMM fabric specific details.

instanceType

instanceType: "VMM"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VMM"

type

type: object

className

className: string = "VmmDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificDetails"

modelProperties

modelProperties: object

Const VmmToAzureCreateNetworkMappingInput

VmmToAzureCreateNetworkMappingInput: object
interface

An interface representing VmmToAzureCreateNetworkMappingInput. Create network mappings input properties/behaviour specific to Vmm to Azure Network mapping.

instanceType

instanceType: "VmmToAzure"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VmmToAzure"

type

type: object

className

className: string = "VmmToAzureCreateNetworkMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificCreateNetworkMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificCreateNetworkMappingInput"

modelProperties

modelProperties: object

Const VmmToAzureNetworkMappingSettings

VmmToAzureNetworkMappingSettings: object
interface

An interface representing VmmToAzureNetworkMappingSettings. E2A Network Mapping fabric specific settings.

instanceType

instanceType: "VmmToAzure"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VmmToAzure"

type

type: object

className

className: string = "VmmToAzureNetworkMappingSettings"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = NetworkMappingFabricSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "NetworkMappingFabricSpecificSettings"

modelProperties

modelProperties: object

Const VmmToAzureUpdateNetworkMappingInput

VmmToAzureUpdateNetworkMappingInput: object
interface

An interface representing VmmToAzureUpdateNetworkMappingInput. Update network mappings input properties/behaviour specific to vmm to azure.

instanceType

instanceType: "VmmToAzure"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VmmToAzure"

type

type: object

className

className: string = "VmmToAzureUpdateNetworkMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificUpdateNetworkMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificUpdateNetworkMappingInput"

modelProperties

modelProperties: object

Const VmmToVmmCreateNetworkMappingInput

VmmToVmmCreateNetworkMappingInput: object
interface

An interface representing VmmToVmmCreateNetworkMappingInput. Create network mappings input properties/behaviour specific to vmm to vmm Network mapping.

instanceType

instanceType: "VmmToVmm"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VmmToVmm"

type

type: object

className

className: string = "VmmToVmmCreateNetworkMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificCreateNetworkMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificCreateNetworkMappingInput"

modelProperties

modelProperties: object

Const VmmToVmmNetworkMappingSettings

VmmToVmmNetworkMappingSettings: object
interface

An interface representing VmmToVmmNetworkMappingSettings. E2E Network Mapping fabric specific settings.

instanceType

instanceType: "VmmToVmm"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VmmToVmm"

type

type: object

className

className: string = "VmmToVmmNetworkMappingSettings"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = NetworkMappingFabricSpecificSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "NetworkMappingFabricSpecificSettings"

modelProperties

modelProperties: object

Const VmmToVmmUpdateNetworkMappingInput

VmmToVmmUpdateNetworkMappingInput: object
interface

An interface representing VmmToVmmUpdateNetworkMappingInput. Update network mappings input properties/behaviour specific to vmm to vmm.

instanceType

instanceType: "VmmToVmm"
member

{string} instanceType Polymorphic Discriminator

serializedName

serializedName: string = "VmmToVmm"

type

type: object

className

className: string = "VmmToVmmUpdateNetworkMappingInput"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FabricSpecificUpdateNetworkMappingInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "FabricSpecificUpdateNetworkMappingInput"

modelProperties

modelProperties: object

Const VmmVirtualMachineDetails

VmmVirtualMachineDetails: object
interface

An interface representing VmmVirtualMachineDetails. VMM fabric provider specific VM settings.

Optional diskDetails

diskDetails: DiskDetails[]
member

{DiskDetails[]} [diskDetails] The Last successful failover time.

Optional generation

generation: undefined | string
member

{string} [generation] The id of the object in fabric.

Optional hasFibreChannelAdapter

hasFibreChannelAdapter: PresenceStatus
member

{PresenceStatus} [hasFibreChannelAdapter] A value indicating whether the VM has a fibre channel adapter attached. String value of {SrsDataContract.PresenceStatus} enum. Possible values include: 'Unknown', 'Present', 'NotPresent'

Optional hasPhysicalDisk

hasPhysicalDisk: PresenceStatus
member

{PresenceStatus} [hasPhysicalDisk] A value indicating whether the VM has a physical disk attached. String value of {SrsDataContract.PresenceStatus} enum. Possible values include: 'Unknown', 'Present', 'NotPresent'

Optional hasSharedVhd

hasSharedVhd: PresenceStatus
member

{PresenceStatus} [hasSharedVhd] A value indicating whether the VM has a shared VHD attached. String value of {SrsDataContract.PresenceStatus} enum. Possible values include: 'Unknown', 'Present', 'NotPresent'

instanceType

instanceType: "VmmVirtualMachine"
member

{string} instanceType Polymorphic Discriminator

Optional osDetails

osDetails: OSDetails
member

{OSDetails} [osDetails] The Last replication time.

Optional sourceItemId

sourceItemId: undefined | string
member

{string} [sourceItemId] The source id of the object.

serializedName

serializedName: string = "VmmVirtualMachine"

type

type: object

className

className: string = "VmmVirtualMachineDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ConfigurationSettings.type.polymorphicDiscriminator

uberParent

uberParent: string = "ConfigurationSettings"

modelProperties

modelProperties: object

diskDetails

diskDetails: object

serializedName

serializedName: string = "diskDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiskDetails"

name

name: "Composite" = "Composite"

generation

generation: object

serializedName

serializedName: string = "generation"

type

type: object

name

name: "String" = "String"

hasFibreChannelAdapter

hasFibreChannelAdapter: object

serializedName

serializedName: string = "hasFibreChannelAdapter"

type

type: object

name

name: "String" = "String"

hasPhysicalDisk

hasPhysicalDisk: object

serializedName

serializedName: string = "hasPhysicalDisk"

type

type: object

name

name: "String" = "String"

hasSharedVhd

hasSharedVhd: object

serializedName

serializedName: string = "hasSharedVhd"

type

type: object

name

name: "String" = "String"

osDetails

osDetails: object

serializedName

serializedName: string = "osDetails"

type

type: object

className

className: string = "OSDetails"

name

name: "Composite" = "Composite"

sourceItemId

sourceItemId: object

serializedName

serializedName: string = "sourceItemId"

type

type: object

name

name: "String" = "String"

Const VmwareCbtPolicyDetails

VmwareCbtPolicyDetails: object
interface

An interface representing VmwareCbtPolicyDetails. VMware Cbt specific policy details.

Optional appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: undefined | number
member

{number} [appConsistentFrequencyInMinutes] The app consistent snapshot frequency in minutes.

Optional crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: undefined | number
member

{number} [crashConsistentFrequencyInMinutes] The crash consistent snapshot frequency in minutes.

instanceType

instanceType: "VMwareCbt"
member

{string} instanceType Polymorphic Discriminator

Optional recoveryPointHistory

recoveryPointHistory: undefined | number
member

{number} [recoveryPointHistory] The duration in minutes until which the recovery points need to be stored.

Optional recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: undefined | number
member

{number} [recoveryPointThresholdInMinutes] The recovery point threshold in minutes.

serializedName

serializedName: string = "VMwareCbt"

type

type: object

className

className: string = "VmwareCbtPolicyDetails"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = PolicyProviderSpecificDetails.type.polymorphicDiscriminator

uberParent

uberParent: string = "PolicyProviderSpecificDetails"

modelProperties

modelProperties: object

appConsistentFrequencyInMinutes

appConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "appConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

crashConsistentFrequencyInMinutes

crashConsistentFrequencyInMinutes: object

serializedName

serializedName: string = "crashConsistentFrequencyInMinutes"

type

type: object

name

name: "Number" = "Number"

recoveryPointHistory

recoveryPointHistory: object

serializedName

serializedName: string = "recoveryPointHistory"

type

type: object

name

name: "Number" = "Number"

recoveryPointThresholdInMinutes

recoveryPointThresholdInMinutes: object

serializedName

serializedName: string = "recoveryPointThresholdInMinutes"

type

type: object

name

name: "Number" = "Number"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const alertSettingName

alertSettingName: object

parameterPath

parameterPath: string = "alertSettingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "alertSettingName"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const discriminators

discriminators: object

ApplyRecoveryPointProviderSpecificInput

ApplyRecoveryPointProviderSpecificInput: CompositeMapper = ApplyRecoveryPointProviderSpecificInput

ApplyRecoveryPointProviderSpecificInput.A2A

ApplyRecoveryPointProviderSpecificInput.A2A: CompositeMapper = A2AApplyRecoveryPointInput

ApplyRecoveryPointProviderSpecificInput.HyperVReplicaAzure

ApplyRecoveryPointProviderSpecificInput.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureApplyRecoveryPointInput

ApplyRecoveryPointProviderSpecificInput.InMageAzureV2

ApplyRecoveryPointProviderSpecificInput.InMageAzureV2: CompositeMapper = InMageAzureV2ApplyRecoveryPointInput

ConfigurationSettings

ConfigurationSettings: CompositeMapper = ConfigurationSettings

ConfigurationSettings.HyperVVirtualMachine

ConfigurationSettings.HyperVVirtualMachine: CompositeMapper = HyperVVirtualMachineDetails

ConfigurationSettings.ReplicationGroupDetails

ConfigurationSettings.ReplicationGroupDetails: CompositeMapper = ReplicationGroupDetails

ConfigurationSettings.VMwareVirtualMachine

ConfigurationSettings.VMwareVirtualMachine: CompositeMapper = VMwareVirtualMachineDetails

ConfigurationSettings.VmmVirtualMachine

ConfigurationSettings.VmmVirtualMachine: CompositeMapper = VmmVirtualMachineDetails

DisableProtectionProviderSpecificInput

DisableProtectionProviderSpecificInput: CompositeMapper = DisableProtectionProviderSpecificInput

DisableProtectionProviderSpecificInput.InMage

DisableProtectionProviderSpecificInput.InMage: CompositeMapper = InMageDisableProtectionProviderSpecificInput

EnableProtectionProviderSpecificInput

EnableProtectionProviderSpecificInput: CompositeMapper = EnableProtectionProviderSpecificInput

EnableProtectionProviderSpecificInput.A2A

EnableProtectionProviderSpecificInput.A2A: CompositeMapper = A2AEnableProtectionInput

EnableProtectionProviderSpecificInput.HyperVReplicaAzure

EnableProtectionProviderSpecificInput.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureEnableProtectionInput

EnableProtectionProviderSpecificInput.InMage

EnableProtectionProviderSpecificInput.InMage: CompositeMapper = InMageEnableProtectionInput

EnableProtectionProviderSpecificInput.InMageAzureV2

EnableProtectionProviderSpecificInput.InMageAzureV2: CompositeMapper = InMageAzureV2EnableProtectionInput

EnableProtectionProviderSpecificInput.San

EnableProtectionProviderSpecificInput.San: CompositeMapper = SanEnableProtectionInput

EventProviderSpecificDetails

EventProviderSpecificDetails: CompositeMapper = EventProviderSpecificDetails

EventProviderSpecificDetails.A2A

EventProviderSpecificDetails.A2A: CompositeMapper = A2AEventDetails

EventProviderSpecificDetails.HyperVReplica2012

EventProviderSpecificDetails.HyperVReplica2012: CompositeMapper = HyperVReplica2012EventDetails

EventProviderSpecificDetails.HyperVReplica2012R2

EventProviderSpecificDetails.HyperVReplica2012R2: CompositeMapper = HyperVReplica2012R2EventDetails

EventProviderSpecificDetails.HyperVReplicaAzure

EventProviderSpecificDetails.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureEventDetails

EventProviderSpecificDetails.HyperVReplicaBaseEventDetails

EventProviderSpecificDetails.HyperVReplicaBaseEventDetails: CompositeMapper = HyperVReplicaBaseEventDetails

EventProviderSpecificDetails.InMageAzureV2

EventProviderSpecificDetails.InMageAzureV2: CompositeMapper = InMageAzureV2EventDetails

EventSpecificDetails

EventSpecificDetails: CompositeMapper = EventSpecificDetails

EventSpecificDetails.JobStatus

EventSpecificDetails.JobStatus: CompositeMapper = JobStatusEventDetails

FabricSpecificCreateNetworkMappingInput

FabricSpecificCreateNetworkMappingInput: CompositeMapper = FabricSpecificCreateNetworkMappingInput

FabricSpecificCreateNetworkMappingInput.AzureToAzure

FabricSpecificCreateNetworkMappingInput.AzureToAzure: CompositeMapper = AzureToAzureCreateNetworkMappingInput

FabricSpecificCreateNetworkMappingInput.VmmToAzure

FabricSpecificCreateNetworkMappingInput.VmmToAzure: CompositeMapper = VmmToAzureCreateNetworkMappingInput

FabricSpecificCreateNetworkMappingInput.VmmToVmm

FabricSpecificCreateNetworkMappingInput.VmmToVmm: CompositeMapper = VmmToVmmCreateNetworkMappingInput

FabricSpecificCreationInput

FabricSpecificCreationInput: CompositeMapper = FabricSpecificCreationInput

FabricSpecificCreationInput.Azure

FabricSpecificCreationInput.Azure: CompositeMapper = AzureFabricCreationInput

FabricSpecificCreationInput.VMwareV2

FabricSpecificCreationInput.VMwareV2: CompositeMapper = VMwareV2FabricCreationInput

FabricSpecificDetails

FabricSpecificDetails: CompositeMapper = FabricSpecificDetails

FabricSpecificDetails.Azure

FabricSpecificDetails.Azure: CompositeMapper = AzureFabricSpecificDetails

FabricSpecificDetails.HyperVSite

FabricSpecificDetails.HyperVSite: CompositeMapper = HyperVSiteDetails

FabricSpecificDetails.VMM

FabricSpecificDetails.VMM: CompositeMapper = VmmDetails

FabricSpecificDetails.VMware

FabricSpecificDetails.VMware: CompositeMapper = VMwareDetails

FabricSpecificDetails.VMwareV2

FabricSpecificDetails.VMwareV2: CompositeMapper = VMwareV2FabricSpecificDetails

FabricSpecificUpdateNetworkMappingInput

FabricSpecificUpdateNetworkMappingInput: CompositeMapper = FabricSpecificUpdateNetworkMappingInput

FabricSpecificUpdateNetworkMappingInput.AzureToAzure

FabricSpecificUpdateNetworkMappingInput.AzureToAzure: CompositeMapper = AzureToAzureUpdateNetworkMappingInput

FabricSpecificUpdateNetworkMappingInput.VmmToAzure

FabricSpecificUpdateNetworkMappingInput.VmmToAzure: CompositeMapper = VmmToAzureUpdateNetworkMappingInput

FabricSpecificUpdateNetworkMappingInput.VmmToVmm

FabricSpecificUpdateNetworkMappingInput.VmmToVmm: CompositeMapper = VmmToVmmUpdateNetworkMappingInput

GroupTaskDetails

GroupTaskDetails: CompositeMapper = GroupTaskDetails

GroupTaskDetails.InlineWorkflowTaskDetails

GroupTaskDetails.InlineWorkflowTaskDetails: CompositeMapper = InlineWorkflowTaskDetails

GroupTaskDetails.RecoveryPlanGroupTaskDetails

GroupTaskDetails.RecoveryPlanGroupTaskDetails: CompositeMapper = RecoveryPlanGroupTaskDetails

GroupTaskDetails.RecoveryPlanShutdownGroupTaskDetails

GroupTaskDetails.RecoveryPlanShutdownGroupTaskDetails: CompositeMapper = RecoveryPlanShutdownGroupTaskDetails

JobDetails

JobDetails: CompositeMapper = JobDetails

JobDetails.AsrJobDetails

JobDetails.AsrJobDetails: CompositeMapper = AsrJobDetails

JobDetails.ExportJobDetails

JobDetails.ExportJobDetails: CompositeMapper = ExportJobDetails

JobDetails.FailoverJobDetails

JobDetails.FailoverJobDetails: CompositeMapper = FailoverJobDetails

JobDetails.SwitchProtectionJobDetails

JobDetails.SwitchProtectionJobDetails: CompositeMapper = SwitchProtectionJobDetails

JobDetails.TestFailoverJobDetails

JobDetails.TestFailoverJobDetails: CompositeMapper = TestFailoverJobDetails

NetworkMappingFabricSpecificSettings

NetworkMappingFabricSpecificSettings: CompositeMapper = NetworkMappingFabricSpecificSettings

NetworkMappingFabricSpecificSettings.AzureToAzure

NetworkMappingFabricSpecificSettings.AzureToAzure: CompositeMapper = AzureToAzureNetworkMappingSettings

NetworkMappingFabricSpecificSettings.VmmToAzure

NetworkMappingFabricSpecificSettings.VmmToAzure: CompositeMapper = VmmToAzureNetworkMappingSettings

NetworkMappingFabricSpecificSettings.VmmToVmm

NetworkMappingFabricSpecificSettings.VmmToVmm: CompositeMapper = VmmToVmmNetworkMappingSettings

PolicyProviderSpecificDetails

PolicyProviderSpecificDetails: CompositeMapper = PolicyProviderSpecificDetails

PolicyProviderSpecificDetails.A2A

PolicyProviderSpecificDetails.A2A: CompositeMapper = A2APolicyDetails

PolicyProviderSpecificDetails.HyperVReplica2012

PolicyProviderSpecificDetails.HyperVReplica2012: CompositeMapper = HyperVReplicaPolicyDetails

PolicyProviderSpecificDetails.HyperVReplica2012R2

PolicyProviderSpecificDetails.HyperVReplica2012R2: CompositeMapper = HyperVReplicaBluePolicyDetails

PolicyProviderSpecificDetails.HyperVReplicaAzure

PolicyProviderSpecificDetails.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzurePolicyDetails

PolicyProviderSpecificDetails.HyperVReplicaBasePolicyDetails

PolicyProviderSpecificDetails.HyperVReplicaBasePolicyDetails: CompositeMapper = HyperVReplicaBasePolicyDetails

PolicyProviderSpecificDetails.InMage

PolicyProviderSpecificDetails.InMage: CompositeMapper = InMagePolicyDetails

PolicyProviderSpecificDetails.InMageAzureV2

PolicyProviderSpecificDetails.InMageAzureV2: CompositeMapper = InMageAzureV2PolicyDetails

PolicyProviderSpecificDetails.InMageBasePolicyDetails

PolicyProviderSpecificDetails.InMageBasePolicyDetails: CompositeMapper = InMageBasePolicyDetails

PolicyProviderSpecificDetails.RcmAzureMigration

PolicyProviderSpecificDetails.RcmAzureMigration: CompositeMapper = RcmAzureMigrationPolicyDetails

PolicyProviderSpecificDetails.VMwareCbt

PolicyProviderSpecificDetails.VMwareCbt: CompositeMapper = VmwareCbtPolicyDetails

PolicyProviderSpecificInput

PolicyProviderSpecificInput: CompositeMapper = PolicyProviderSpecificInput

PolicyProviderSpecificInput.A2A

PolicyProviderSpecificInput.A2A: CompositeMapper = A2APolicyCreationInput

PolicyProviderSpecificInput.HyperVReplica2012

PolicyProviderSpecificInput.HyperVReplica2012: CompositeMapper = HyperVReplicaPolicyInput

PolicyProviderSpecificInput.HyperVReplica2012R2

PolicyProviderSpecificInput.HyperVReplica2012R2: CompositeMapper = HyperVReplicaBluePolicyInput

PolicyProviderSpecificInput.HyperVReplicaAzure

PolicyProviderSpecificInput.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzurePolicyInput

PolicyProviderSpecificInput.InMage

PolicyProviderSpecificInput.InMage: CompositeMapper = InMagePolicyInput

PolicyProviderSpecificInput.InMageAzureV2

PolicyProviderSpecificInput.InMageAzureV2: CompositeMapper = InMageAzureV2PolicyInput

PolicyProviderSpecificInput.VMwareCbt

PolicyProviderSpecificInput.VMwareCbt: CompositeMapper = VMwareCbtPolicyCreationInput

ProtectionContainerMappingProviderSpecificDetails

ProtectionContainerMappingProviderSpecificDetails: CompositeMapper = ProtectionContainerMappingProviderSpecificDetails

ProtectionContainerMappingProviderSpecificDetails.A2A

ProtectionContainerMappingProviderSpecificDetails.A2A: CompositeMapper = A2AProtectionContainerMappingDetails

ProviderSpecificFailoverInput

ProviderSpecificFailoverInput: CompositeMapper = ProviderSpecificFailoverInput

ProviderSpecificFailoverInput.A2A

ProviderSpecificFailoverInput.A2A: CompositeMapper = A2AFailoverProviderInput

ProviderSpecificFailoverInput.HyperVReplicaAzure

ProviderSpecificFailoverInput.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureFailoverProviderInput

ProviderSpecificFailoverInput.HyperVReplicaAzureFailback

ProviderSpecificFailoverInput.HyperVReplicaAzureFailback: CompositeMapper = HyperVReplicaAzureFailbackProviderInput

ProviderSpecificFailoverInput.InMage

ProviderSpecificFailoverInput.InMage: CompositeMapper = InMageFailoverProviderInput

ProviderSpecificFailoverInput.InMageAzureV2

ProviderSpecificFailoverInput.InMageAzureV2: CompositeMapper = InMageAzureV2FailoverProviderInput

ProviderSpecificRecoveryPointDetails

ProviderSpecificRecoveryPointDetails: CompositeMapper = ProviderSpecificRecoveryPointDetails

ProviderSpecificRecoveryPointDetails.A2A

ProviderSpecificRecoveryPointDetails.A2A: CompositeMapper = A2ARecoveryPointDetails

ProviderSpecificRecoveryPointDetails.InMageAzureV2

ProviderSpecificRecoveryPointDetails.InMageAzureV2: CompositeMapper = InMageAzureV2RecoveryPointDetails

RecoveryPlanActionDetails

RecoveryPlanActionDetails: CompositeMapper = RecoveryPlanActionDetails

RecoveryPlanActionDetails.AutomationRunbookActionDetails

RecoveryPlanActionDetails.AutomationRunbookActionDetails: CompositeMapper = RecoveryPlanAutomationRunbookActionDetails

RecoveryPlanActionDetails.ManualActionDetails

RecoveryPlanActionDetails.ManualActionDetails: CompositeMapper = RecoveryPlanManualActionDetails

RecoveryPlanActionDetails.ScriptActionDetails

RecoveryPlanActionDetails.ScriptActionDetails: CompositeMapper = RecoveryPlanScriptActionDetails

RecoveryPlanProviderSpecificFailoverInput

RecoveryPlanProviderSpecificFailoverInput: CompositeMapper = RecoveryPlanProviderSpecificFailoverInput

RecoveryPlanProviderSpecificFailoverInput.A2A

RecoveryPlanProviderSpecificFailoverInput.A2A: CompositeMapper = RecoveryPlanA2AFailoverInput

RecoveryPlanProviderSpecificFailoverInput.HyperVReplicaAzure

RecoveryPlanProviderSpecificFailoverInput.HyperVReplicaAzure: CompositeMapper = RecoveryPlanHyperVReplicaAzureFailoverInput

RecoveryPlanProviderSpecificFailoverInput.HyperVReplicaAzureFailback

RecoveryPlanProviderSpecificFailoverInput.HyperVReplicaAzureFailback: CompositeMapper = RecoveryPlanHyperVReplicaAzureFailbackInput

RecoveryPlanProviderSpecificFailoverInput.InMage

RecoveryPlanProviderSpecificFailoverInput.InMage: CompositeMapper = RecoveryPlanInMageFailoverInput

RecoveryPlanProviderSpecificFailoverInput.InMageAzureV2

RecoveryPlanProviderSpecificFailoverInput.InMageAzureV2: CompositeMapper = RecoveryPlanInMageAzureV2FailoverInput

ReplicationProviderSpecificContainerCreationInput

ReplicationProviderSpecificContainerCreationInput: CompositeMapper = ReplicationProviderSpecificContainerCreationInput

ReplicationProviderSpecificContainerCreationInput.A2A

ReplicationProviderSpecificContainerCreationInput.A2A: CompositeMapper = A2AContainerCreationInput

ReplicationProviderSpecificContainerMappingInput

ReplicationProviderSpecificContainerMappingInput: CompositeMapper = ReplicationProviderSpecificContainerMappingInput

ReplicationProviderSpecificContainerMappingInput.A2A

ReplicationProviderSpecificContainerMappingInput.A2A: CompositeMapper = A2AContainerMappingInput

ReplicationProviderSpecificSettings

ReplicationProviderSpecificSettings: CompositeMapper = ReplicationProviderSpecificSettings

ReplicationProviderSpecificSettings.A2A

ReplicationProviderSpecificSettings.A2A: CompositeMapper = A2AReplicationDetails

ReplicationProviderSpecificSettings.HyperVReplica2012

ReplicationProviderSpecificSettings.HyperVReplica2012: CompositeMapper = HyperVReplicaReplicationDetails

ReplicationProviderSpecificSettings.HyperVReplica2012R2

ReplicationProviderSpecificSettings.HyperVReplica2012R2: CompositeMapper = HyperVReplicaBlueReplicationDetails

ReplicationProviderSpecificSettings.HyperVReplicaAzure

ReplicationProviderSpecificSettings.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureReplicationDetails

ReplicationProviderSpecificSettings.HyperVReplicaBaseReplicationDetails

ReplicationProviderSpecificSettings.HyperVReplicaBaseReplicationDetails: CompositeMapper = HyperVReplicaBaseReplicationDetails

ReplicationProviderSpecificSettings.InMage

ReplicationProviderSpecificSettings.InMage: CompositeMapper = InMageReplicationDetails

ReplicationProviderSpecificSettings.InMageAzureV2

ReplicationProviderSpecificSettings.InMageAzureV2: CompositeMapper = InMageAzureV2ReplicationDetails

ReplicationProviderSpecificUpdateContainerMappingInput

ReplicationProviderSpecificUpdateContainerMappingInput: CompositeMapper = ReplicationProviderSpecificUpdateContainerMappingInput

ReplicationProviderSpecificUpdateContainerMappingInput.A2A

ReplicationProviderSpecificUpdateContainerMappingInput.A2A: CompositeMapper = A2AUpdateContainerMappingInput

ReverseReplicationProviderSpecificInput

ReverseReplicationProviderSpecificInput: CompositeMapper = ReverseReplicationProviderSpecificInput

ReverseReplicationProviderSpecificInput.A2A

ReverseReplicationProviderSpecificInput.A2A: CompositeMapper = A2AReprotectInput

ReverseReplicationProviderSpecificInput.HyperVReplicaAzure

ReverseReplicationProviderSpecificInput.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureReprotectInput

ReverseReplicationProviderSpecificInput.InMage

ReverseReplicationProviderSpecificInput.InMage: CompositeMapper = InMageReprotectInput

ReverseReplicationProviderSpecificInput.InMageAzureV2

ReverseReplicationProviderSpecificInput.InMageAzureV2: CompositeMapper = InMageAzureV2ReprotectInput

SwitchProtectionProviderSpecificInput

SwitchProtectionProviderSpecificInput: CompositeMapper = SwitchProtectionProviderSpecificInput

SwitchProtectionProviderSpecificInput.A2A

SwitchProtectionProviderSpecificInput.A2A: CompositeMapper = A2ASwitchProtectionInput

TaskTypeDetails

TaskTypeDetails: CompositeMapper = TaskTypeDetails

TaskTypeDetails.AutomationRunbookTaskDetails

TaskTypeDetails.AutomationRunbookTaskDetails: CompositeMapper = AutomationRunbookTaskDetails

TaskTypeDetails.ConsistencyCheckTaskDetails

TaskTypeDetails.ConsistencyCheckTaskDetails: CompositeMapper = ConsistencyCheckTaskDetails

TaskTypeDetails.FabricReplicationGroupTaskDetails

TaskTypeDetails.FabricReplicationGroupTaskDetails: CompositeMapper = FabricReplicationGroupTaskDetails

TaskTypeDetails.JobTaskDetails

TaskTypeDetails.JobTaskDetails: CompositeMapper = JobTaskDetails

TaskTypeDetails.ManualActionTaskDetails

TaskTypeDetails.ManualActionTaskDetails: CompositeMapper = ManualActionTaskDetails

TaskTypeDetails.ScriptActionTaskDetails

TaskTypeDetails.ScriptActionTaskDetails: CompositeMapper = ScriptActionTaskDetails

TaskTypeDetails.VirtualMachineTaskDetails

TaskTypeDetails.VirtualMachineTaskDetails: CompositeMapper = VirtualMachineTaskDetails

TaskTypeDetails.VmNicUpdatesTaskDetails

TaskTypeDetails.VmNicUpdatesTaskDetails: CompositeMapper = VmNicUpdatesTaskDetails

UpdateReplicationProtectedItemProviderInput

UpdateReplicationProtectedItemProviderInput: CompositeMapper = UpdateReplicationProtectedItemProviderInput

UpdateReplicationProtectedItemProviderInput.A2A

UpdateReplicationProtectedItemProviderInput.A2A: CompositeMapper = A2AUpdateReplicationProtectedItemInput

UpdateReplicationProtectedItemProviderInput.HyperVReplicaAzure

UpdateReplicationProtectedItemProviderInput.HyperVReplicaAzure: CompositeMapper = HyperVReplicaAzureUpdateReplicationProtectedItemInput

UpdateReplicationProtectedItemProviderInput.InMageAzureV2

UpdateReplicationProtectedItemProviderInput.InMageAzureV2: CompositeMapper = InMageAzureV2UpdateReplicationProtectedItemInput

Const eventName

eventName: object

parameterPath

parameterPath: string = "eventName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "eventName"

type

type: object

name

name: "String" = "String"

Const fabricName

fabricName: object

parameterPath

parameterPath: string = "fabricName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobName"

type

type: object

name

name: "String" = "String"

Const logicalNetworkName

logicalNetworkName: object

parameterPath

parameterPath: string = "logicalNetworkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "logicalNetworkName"

type

type: object

name

name: "String" = "String"

Const mappingName

mappingName: object

parameterPath

parameterPath: string = "mappingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "mappingName"

type

type: object

name

name: "String" = "String"

Const networkMappingName

networkMappingName: object

parameterPath

parameterPath: string = "networkMappingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkMappingName"

type

type: object

name

name: "String" = "String"

Const networkName

networkName: object

parameterPath

parameterPath: string = "networkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const policyName

policyName: object

parameterPath

parameterPath: string = "policyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

Const protectableItemName

protectableItemName: object

parameterPath

parameterPath: string = "protectableItemName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "protectableItemName"

type

type: object

name

name: "String" = "String"

Const protectionContainerName

protectionContainerName: object

parameterPath

parameterPath: string = "protectionContainerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "protectionContainerName"

type

type: object

name

name: "String" = "String"

Const providerName

providerName: object

parameterPath

parameterPath: string = "providerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "providerName"

type

type: object

name

name: "String" = "String"

Const recoveryPlanName

recoveryPlanName: object

parameterPath

parameterPath: string = "recoveryPlanName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "recoveryPlanName"

type

type: object

name

name: "String" = "String"

Const recoveryPointName

recoveryPointName: object

parameterPath

parameterPath: string = "recoveryPointName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "recoveryPointName"

type

type: object

name

name: "String" = "String"

Const replicatedProtectedItemName

replicatedProtectedItemName: object

parameterPath

parameterPath: string = "replicatedProtectedItemName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "replicatedProtectedItemName"

type

type: object

name

name: "String" = "String"

Const replicationProtectedItemName

replicationProtectedItemName: object

parameterPath

parameterPath: string = "replicationProtectedItemName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "replicationProtectedItemName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const resourceName

resourceName: object

parameterPath

parameterPath: string = "resourceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceName"

type

type: object

name

name: "String" = "String"

Const skipToken

skipToken: object

parameterPath

parameterPath: string[] = ["options","skipToken"]

mapper

mapper: object

serializedName

serializedName: string = "skipToken"

type

type: object

name

name: "String" = "String"

Const storageClassificationMappingName

storageClassificationMappingName: object

parameterPath

parameterPath: string = "storageClassificationMappingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "storageClassificationMappingName"

type

type: object

name

name: "String" = "String"

Const storageClassificationName

storageClassificationName: object

parameterPath

parameterPath: string = "storageClassificationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "storageClassificationName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const vCenterName

vCenterName: object

parameterPath

parameterPath: string = "vCenterName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "vCenterName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc